HomeGuidesAPI reference
Analytics APIEndpoints

Statistics used by the headlines dashboard

Returns one item per headline of the player's headline test, with views, plays, engagement, pitch retention, clicks and conversions. Dates are read in UTC. If the player does not exist in the company, the response is `400` with `{"error": ["Player could not be found for the current request"]}`.

POST
/headlines/stats_by_player

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Access the application and copy your api token, then, just set the header X-Api-Token with it.

In: header

X-Api-Version<token>

The API version to use. Currently supported versions are:

  • v1: The current stable version

A request without this header, or with any other value, is answered by the edge with 404 and {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

A non-empty User-Agent identifying your integration is required. Requests without it are rejected at the edge before reaching the API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/headlines/stats_by_player" \  -H "Content-Type: application/json" \  -d '{    "start_date": "2026-09-01 00:00:00",    "end_date": "2026-09-30 23:59:59",    "player_id": "64a5c8072e6fd10009828db2",    "video_duration": 1200,    "pitch_time": 300  }'
[  {    "number": 1,    "views": 140,    "plays": 52,    "engagement": 0.42,    "play_rate": 0.35,    "play_over_engagement": 0.147,    "pitch": 0.18,    "clicks": 12,    "conversions": 3,    "amount_brl": 59100,    "amount_usd": 0,    "amount_eur": 0,    "conversion_rate": 5.77  },  {    "number": 2,    "views": 150,    "plays": 61,    "engagement": 0.37,    "play_rate": 0.39,    "play_over_engagement": 0.1443,    "pitch": 0.15,    "clicks": 9,    "conversions": 2,    "amount_brl": 39400,    "amount_usd": 0,    "amount_eur": 0,    "conversion_rate": 3.28  }]

Returns the clicks of a player for each day POST

Returns the clicks of a player for each day of the period, in `timezone`, with totals for the whole period. Days without clicks come with zeros.

Returns statistics of all sessions of a player POST

Returns the totals of the sessions of a player in the period: views, plays, finishes, clicks, engagement, pitch retention and conversions.