News Feed Card Analytics

GET https://{{instance_url}}/feed/data_series?card_id={{card_identifier}}&length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00

This endpoint allows you to retrieve a daily series of engagement stats for a card over time.

Components Used

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "data" : [
        {
            "time" : (string) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "clicks" : (int) ,
            "impressions" : (int),
            "unique_clicks" : (int),
            "unique_impressions" : (int)
        },
        ...
    ]
}

Request Params

KeyDatatypeRequiredDescription
card_idstring(Required) String

Card API identifier | | length | number | | (Required) Integer

Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100 inclusive | | unit | string | | (Optional) String

Unit of time between data points - can be "day" or "hour" (defaults to "day") | | ending_at | string | | (Optional) DateTime (ISO 8601 string)

Date on which the data series should end - defaults to time of the request |

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring