DevelopersAPI referenceLinksAnalytics
Account-wide link analytics
Account-wide totals, the top five links by clicks, a daily click series, and country/device/browser/referrer breakdowns across all links for the requested window. Bot traffic is excluded from series and breakdowns.
View as MarkdownAuthorization
bearer AuthorizationBearer <token>
In: header
Query Parameters
days?integer
Analytics window in days; other values fall back to 14
Default
14Value in
- 7
- 14
- 30
- 90
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/analytics/summary"{ "totalLinks": 0, "activeLinks": 0, "totalClicks": 0, "topLinks": [ { "id": "string", "shortCode": "string", "shortUrl": "string", "destinationUrl": "string", "title": "string", "tags": [ "string" ], "clicks": 0, "active": true, "archived": true, "trackConversions": true, "expiresAt": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z", "updated": "2019-08-24T14:15:22Z", "visibility": "private", "ownerId": "string" } ], "byDay": [ { "date": "string", "clicks": 0 } ], "breakdowns": { "byCountry": [ { "key": "string", "clicks": 0 } ], "byDevice": [ { "key": "string", "clicks": 0 } ], "byBrowser": [ { "key": "string", "clicks": 0 } ], "byReferrer": [ { "key": "string", "clicks": 0 } ], "byVariant": [ { "key": "string", "clicks": 0 } ] }, "conversions": { "count": 0, "revenueCents": 0 }, "days": 0}Record a conversion for a click
Attributes a conversion to a click. Links with trackConversions enabled append ?esrx_id=<click id> to their destination; the customer's backend captures it and posts it here (typically with an org API key) when the visitor signs up or pays. Clicks are written asynchronously, so an instant conversion can 404 once — retry after a second.
List the caller's bio pages
Next Page