logo Facebook Sether API

get_facebook_post_shares

Description:

The number of how many times your ads have been shared via Facebook instances. It may also include Instagram shares sent to people’s inboxes.

Definition:

function get_facebook_post_shares(
            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 Facebook 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_facebook_post_reactions

Description:

The number of interactions manifested as reactions (like, love, haha etc.) for your ads, while they were running.

Definition:

function get_facebook_post_reactions(
            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 Facebook 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_facebook_post_engagements

Description:

The number of times people have engaged with your posts through likes, comments, shares, and more.

Definition:

function get_facebook_post_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 Facebook 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_facebook_post_comments

Description:

The total number of comments made on your ads while they were running.

Definition:

function get_facebook_post_comments(
            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 Facebook 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_facebook_page_likes

Description:

The metric counts Facebook Page likes attributed to your ads (Like Page button in your ads).

Definition:

function get_facebook_page_likes(
            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 Facebook 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_facebook_impressions

Description:

The number of times that your adverts were on-screen.

Definition:

function get_facebook_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 Facebook 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_facebook_ctr

Description:

CTR is the number of clicks that your ad receives divided by the number of times your ad is shown: clicks / impressions = CTR.

Definition:

function get_facebook_ctr(
            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 Facebook 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_facebook_clicks

Description:

The metric clicks (all) includes link clicks as well as clicks on other parts of your ad (ex: someone clicks on your Page’s name).

Definition:

function get_facebook_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 Facebook 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_facebook_adrecall

Description:

The estimated ad recall lift metric shows how many people we estimate would remember seeing your ad if we asked them within 2 days.

Definition:

function get_facebook_adrecall(
            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 Facebook 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_facebook_3s_video_views3SecondViews

Description:

Unavailable

Definition:

function get_facebook_3s_video_views3SecondViews(
            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 Facebook 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_facebook_spec_page_impressions

Description:

The number of times that your page was on-screen.

Definition:

function get_facebook_spec_page_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 Facebook 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_facebook_spec_page_fans

Description:

Total number of fans on your page.

Definition:

function get_facebook_spec_page_fans(
            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 Facebook 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_facebook_spec_page_views_total

Description:

The number of times a Page’s profile has been viewed by logged in and logged out people.

Definition:

function get_facebook_spec_page_views_total(
            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 Facebook 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_facebook_spec_page_video_views

Description:

The number of times your Page’s videos played for at least 3 seconds, or for nearly their total length if they’re shorter than 3 seconds, broken down by total, paid, and non-paid.

Definition:

function get_facebook_spec_page_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 Facebook 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_facebook_spec_page_engaged_users

Description:

This is the number of engaged individuals who have clicked anywhere on one of your Facebook Page posts.

Definition:

function get_facebook_spec_page_engaged_users(
            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 Facebook 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_facebook_spec_page_fans_day

Description:

Fans per day ratio.

Definition:

function get_facebook_spec_page_fans_day(
            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 Facebook 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_facebook_spec_page_impressions_unique

Description:

Impressions are the number of unique times your content is displayed, no matter if it was clicked or not.

Definition:

function get_facebook_spec_page_impressions_unique(
            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 Facebook 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_facebook_spec_page_impressions_paid

Description:

The number of paid times that your page was on-screen.

Definition:

function get_facebook_spec_page_impressions_paid(
            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 Facebook 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