Retrieving metrics


The ability to retrieve metrics is at the heart of Calibre’s API. In this guide we’ll demonstrate how to fetch metrics for your pages efficiently.

Timeseries metrics for a given Site

Required API Permission: Read Sites
ParameterRequiredDescription
siteYesSite slug, found in site settings
fromNoA ISO8601 timestamp or JavaScript date object signifying the start of date range to be fetched
toNoA ISO8601 timestamp or JavaScript date object signifying the end of date range to be fetched
pagesNoAn array of page UUIDs
profilesNoAn array of test profile UUIDs
jsonNoReturns metrics in JSON format
csvNoReturns metrics in CSV format
metricsNoAn array of the metrics to be returned
Example response

Metrics from a single Snapshot

Required API Permission: Read Sites
ParameterRequiredDescription
siteYesSite slug, found in site settings
snapshotIdYesThe numeric identifer corresponding to a snapshot
jsonNoReturns metrics in JSON format
csvNoReturns metrics in CSV format
Example response