logo Instagram Sether API

get_instagram_reach

Description:

The number of people who saw your adverts at least once. Reach is different to impressions, which may include multiple views of your adverts by the same people.

Definition:

function get_instagram_reach(
            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 Instagram 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_instagram_impressions

Description:

The percentage of times that people saw your ad.

Definition:

function get_instagram_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 Instagram 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_instagram_clicks

Description:

The number of clicks on your post, both link clicks or other clicks (eg: click on people’s name in comments).

Definition:

function get_instagram_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 Instagram 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_instagram_account_reach

Description:

The number of people who saw your account at least once. Reach is different to impressions, which may include multiple views of your account by the same people.

Definition:

function get_instagram_account_reach(
            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 Instagram 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_instagram_account_views

Description:

The total number of unique accounts that have viewed this profile.

Definition:

function get_instagram_account_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 Instagram 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_instagram_account_impressions

Description:

The percentage of times that people saw this account.

Definition:

function get_instagram_account_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 Instagram 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_instagram_account_followers

Description:

The total number of unique accounts following this profile.

Definition:

function get_instagram_account_followers(
            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 Instagram 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_instagram_post_reach

Description:

The percentage of times that people saw your ad and performed a click.

Definition:

function get_instagram_post_reach(
            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 Instagram 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_instagram_post_impressions

Description:

The number of people who saw your adverts at least once. Reach is different to impressions, which may include multiple views of your adverts by the same people.

Definition:

function get_instagram_post_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 Instagram 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_instagram_post_engagements

Description:

Post engagement includes all actions that people take involving your ads while they’re running - actions such as reacting to, commenting on or sharing the ad, claiming an offer, viewing a photo or video, or clicking on a link.

Definition:

function get_instagram_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 Instagram 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_instagram_post_3s_video_views

Description:

The metric counts the number of times your video played for 3 seconds, or for 97% of its total length if it’s shorter than 3 seconds.

Definition:

function get_instagram_post_3s_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 Instagram 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_instagram_post_replies

Description:

The post replies metric counts total number of unique accounts that have replied on your post.

Definition:

function get_instagram_post_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 Instagram 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