/links/{linkID}/insights

get

https://www.toneden.io/api/v1/links/{linkID}/insights

Retrieve performance data for a specific link by ID.

Path Params

linkID

integer

required

Numeric ID of the link to retrieve performance data for.

Query Params

metric

string

enum

required

Which action type to query results for. 'rsvps' is only a valid value for livestream links.

Allowed:

start_date

string

If provided, only actions that occurred after the specified date will be counted. Should be in ISO 8601 format.

end_date

string

If provided, only actions that occurred before the specified date will be counted. Should be in ISO 8601 format.

aggregate_interval

string

enum

If provided, results will be grouped into rows based on the specified aggregate interval.

Allowed:

aggregate_geo

string

enum

If provided, results will be grouped according to the location of the visiting fan. Location data is only available for a subset of link clicks.

Allowed:

aggregate_by_referrer

boolean

Defaults to false

If provided, results will be grouped according to the domain that referred the fan to the fanlink.

aggregate_by_service

boolean

Defaults to false

If provided, results will be grouped according to the service that the fan clicked on.

for_distinct_fans

boolean

Defaults to false

If true, only one action per fan will be counted in the stats, even if the fan performed multiple clicks or clickthroughs.

Response

200Successfully retrieved performance data.