logo Twitter Sether API

get_twitter_video_views

Description:

The number of times that a video was viewed. YouTube treats a view as a count when the video is played for 30 seconds or more. If a video is shorter than 30 seconds, it will be counted as a complete video play.

Definition:

function get_twitter_video_views(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_retweets

Description:

This metric comprises the total number of retweets. A Retweet is a re-posting of a Tweet. Twitter’s Retweet feature helps you and others quickly share that Tweet with all of your followers.

Definition:

function get_twitter_retweets(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_replies

Description:

This metric comprises the total number of tweet replies for the content you have posted on Twitter.

Definition:

function get_twitter_replies(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_impressions

Description:

Impressions are the number of times your Tweets are displayed, no matter if they were clicked or not.

Definition:

function get_twitter_impressions(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_follows

Description:

This metric comprises the total number of follows that your account has initiated.

Definition:

function get_twitter_follows(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_engagements

Description:

This metric comprises the total number of times a user interacted with one of your Tweets. Clicks anywhere on the Tweet, including Retweets, replies, follows, likes, links, etc.

Definition:

function get_twitter_engagements(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_twitter_clicks

Description:

When a user either clicks directly on a promoted campaign or component of a promoted campaign.

Definition:

function get_twitter_clicks(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the Twitter platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side