logo Linkedin Sether API

get_linkedin_viral_impressions

Description:

The count of viral impressions (those resulting from a user sharing a sponsored update to their own network of connections).

Definition:

function get_linkedin_viral_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 Linkedin 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_linkedin_video_views

Description:

The count of viewing at least two continuous seconds of playback while the video is at least 50% on screen, or a click on the CTA, whichever comes first.

Definition:

function get_linkedin_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 Linkedin 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_linkedin_likes

Description:

The number of likes your ad received. Likes is part of the Engagement metrics.

Definition:

function get_linkedin_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 Linkedin 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_linkedin_impressions

Description:

The count of ‘impressions’ for Direct Ads and Sponsored Updates and ‘sends’ for InMails.

Definition:

function get_linkedin_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 Linkedin 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_linkedin_follows

Description:

The count of follows generated by running adverts.

Definition:

function get_linkedin_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 Linkedin 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_linkedin_engagements

Description:

The number of times people engaged with your ad (paid and free clicks).

Definition:

function get_linkedin_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 Linkedin 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_linkedin_clicks

Description:

The count of chargeable clicks - clicks that lead to the landing page and clicks that lead to the LinkedIn Page of the organization.

Definition:

function get_linkedin_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 Linkedin 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