REST API

Stats

Stats: 2 endpoints of the REST API.

GET/links/{link}/stats

Get the counters of a link

The environment counters for one link plus the top 5 values of OS, country, in-app browser and match method. A link of another environment is a 404.

Secret key scope (any of): analytics:read

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.
`range (query)`	`"7d" \| "30d"`	The last 7 or 30 project-local days, today included. Default `7d`.

Responses

200 The link counters.

Field	Type	Description
`range`required	`"7d" \| "30d"`
`from`required	`string (date)`	First day of the range (project-local).
`to`required	`string (date)`	Last day of the range, today (project-local).
`timezone`required	`string`	IANA zone that defines a day.
`totals`required	`object`
`totals.clicks`required	`integer`	Non-bot clicks.
`totals.unique_clicks`required	`integer`	Visitors, counted once per link and day (approximate by design).
`totals.installs`required	`integer`	New installs: first opens that are not reinstalls.
`totals.attributed_installs`required	`integer`	New installs credited to a link by a deterministic match (probabilistic matches excluded).
`totals.first_opens`required	`integer`	Every first app open, reinstalls included.
`totals.reengagements`required	`integer`	Opens of an already installed app through a link.
`totals.events`required	`integer`	Custom events received.
`series`required	`object[]`	One point per day, zero-filled.
`series[].clicks`required	`integer`	Non-bot clicks.
`series[].unique_clicks`required	`integer`	Visitors, counted once per link and day (approximate by design).
`series[].installs`required	`integer`	New installs: first opens that are not reinstalls.
`series[].attributed_installs`required	`integer`	New installs credited to a link by a deterministic match (probabilistic matches excluded).
`series[].first_opens`required	`integer`	Every first app open, reinstalls included.
`series[].reengagements`required	`integer`	Opens of an already installed app through a link.
`series[].events`required	`integer`	Custom events received.
`series[].day`required	`string (date)`	Project-local calendar day.
`freshness`required	`object`
`freshness.as_of`required	`string (date-time) \| null`	When the rollups last wrote data for this scope; null when there is none.
`freshness.caught_up`required	`boolean`	True when the rollups wrote within the last 10 minutes.
`breakdowns`required	`object`	Top 5 values each.
`breakdowns.os`required	`object[]`
`breakdowns.os[].value`required	`string \| null`	The value; null is unknown (os, country), a regular browser (in_app_browser) or an organic install (match_method).
`breakdowns.os[].clicks`required	`integer`	Non-bot clicks with this value.
`breakdowns.os[].unique_clicks`required	`integer`	Visitors with this value.
`breakdowns.os[].installs`required	`integer`	Installs credited to the link with this value.
`breakdowns.country`required	`object[]`
`breakdowns.country[].value`required	`string \| null`	The value; null is unknown (os, country), a regular browser (in_app_browser) or an organic install (match_method).
`breakdowns.country[].clicks`required	`integer`	Non-bot clicks with this value.
`breakdowns.country[].unique_clicks`required	`integer`	Visitors with this value.
`breakdowns.country[].installs`required	`integer`	Installs credited to the link with this value.
`breakdowns.in_app_browser`required	`object[]`
`breakdowns.in_app_browser[].value`required	`string \| null`	The value; null is unknown (os, country), a regular browser (in_app_browser) or an organic install (match_method).
`breakdowns.in_app_browser[].clicks`required	`integer`	Non-bot clicks with this value.
`breakdowns.in_app_browser[].unique_clicks`required	`integer`	Visitors with this value.
`breakdowns.in_app_browser[].installs`required	`integer`	Installs credited to the link with this value.
`breakdowns.match_method`required	`object[]`
`breakdowns.match_method[].value`required	`string \| null`	The value; null is unknown (os, country), a regular browser (in_app_browser) or an organic install (match_method).
`breakdowns.match_method[].clicks`required	`integer`	Non-bot clicks with this value.
`breakdowns.match_method[].unique_clicks`required	`integer`	Visitors with this value.
`breakdowns.match_method[].installs`required	`integer`	Installs credited to the link with this value.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/links/{link}/stats" \
  -H "Authorization: Bearer $SECRET_KEY"

GET/stats/summary

Get the environment counters

Clicks, unique clicks, installs, attributed installs (deterministic matches only), first opens, re-engagements and events of the last 7 or 30 project-local days, with a zero-filled daily series. Read from the rollups, so the newest minutes may be missing (see freshness).