API Guide







Get Analytics Engagement

This API provides an engagement breakdown by read, skimmed, glanced or unread.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:

https://api.250ok.com/api/1.0/analytics/engagement

Sample Output:

{
    "read": 38071,
    "skimmed": 14180,
    "glancedorunread": 6265
}
        

Parameters

Parameter Description Acceptable Values Required
startdate Includes activity after the specified date. If unspecified, will default to 30 days prior. yyyy-mm-dd N
enddate Includes activity detected before the specified. If unspecified, will default to the current date. yyyy-mm-dd N

Error Responses

Description Code Cause
No results found. 404 We couldn't find any results matching your criteria.
Invalid start date format. 404 The start date provided was submitted in an invalid format.
Invalid end date format. 404 The end date provided was submitted in an invalid format.