Conversion tracking API reference

The conversion tracking analytics API lets you query conversion data programmatically and pull it into BI tools, custom dashboards, or internal reports. This is a reporting API, not a tracking endpoint — the SDK sends events from the browser, and these endpoints read them back. If you are looking for how to record conversions, see the quickstart and custom events pages.

The base URL for all endpoints is https://tracking.api.rebrandly.com/v1.

Authentication

All requests require your Rebrandly API key in the apikey request header. This is your Tracking API Key from Settings > Conversion tracking — not the general account API key.

apikey: YOUR_API_KEY

The authenticated user must own the workspace specified by workspace_id. Requests for a workspace the user does not own return 403 forbidden. If the authorization service is unreachable, the API returns 503.

Rate limits

All endpoints return 429 rate_limit_exceeded when the request rate is exceeded. Limits are enforced per account tier.

Error format

All errors follow a consistent shape:

{
  "success": false,
  "error": "error_code",
  "message": "Human-readable description"
}

`error`	HTTP status	When it occurs
`unauthorized`	401	Missing or invalid API key
`validation_error`	400	A required parameter is missing or a value is invalid
`forbidden`	403	The authenticated user does not own the requested workspace
`not_found`	404	The requested resource does not exist
`rate_limit_exceeded`	429	Request rate exceeded for the account tier
`server_error`	500	Unexpected server-side failure

Common query parameters

The following parameters are accepted by all analytics endpoints.

Parameter	Type	Description
`workspace_id`	string	Required. The workspace to query.
`link_ids[]`	string	Filter results to one or more link IDs. Repeat the parameter to pass multiple values.
`start_date` / `end_date`	ISO 8601 datetime	Query a specific date range. Cannot be used together with `preset`.
`preset`	string	A named time range. One of: `today`, `yesterday`, `last_24_hours`, `last_7_days`, `last_30_days`, `last_90_days`, `this_month`, `last_month`, `all_time`. Cannot be used together with `start_date` / `end_date`.
`format`	string	Response format. `json` (default) or `csv`.

The maximum queryable date range is two years for most endpoints, and one year for paths and other journey analytics endpoints.

📘
CSV export
All endpoints support format=csv. This is the recommended approach for feeding conversion data into BI tools or spreadsheet workflows — request the data once and import it directly without parsing JSON.

📘
Cache TTL
All analytics endpoints have a 5-minute cache TTL. Responses reflect conversion data as of the most recent cache refresh, not real-time.

Endpoints

Endpoint	Method	Description
`/v1/analytics/summary`	GET	Totals for clicks, events, conversions, and revenue
`/v1/analytics/timeseries`	GET	Time-bucketed data with configurable granularity
`/v1/analytics/funnel`	GET	Drop-off analysis across the conversion funnel
`/v1/analytics/events`	GET	Event breakdown with counts and revenue metrics
`/v1/analytics/top-links`	GET	Links ranked by performance metrics
`/v1/analytics/time-to-conversion`	GET	Histogram of time elapsed between click and conversion
`/v1/analytics/paths`	GET	Journey path data for Sankey visualization

/v1/analytics/summary

Returns aggregate totals — clicks, events, conversions, and revenue — for the specified workspace and date range. Accepts an optional second date range for period-over-period comparison. Use this endpoint to populate headline metrics in a dashboard.

/v1/analytics/timeseries

Returns the same metrics as summary broken into time buckets. The granularity parameter controls bucket size: hour, day, week, or month. Use this endpoint to power trend charts and time-based visualizations.

/v1/analytics/funnel

Returns drop-off counts across three stages: clicks, page views, and conversions. Use this endpoint to understand what proportion of link clicks result in a tracked conversion event.

/v1/analytics/events

Returns a breakdown of tracked events with counts and revenue metrics. Each row represents a distinct (event, label) combination — two conversions with different labels appear as separate rows. Use this endpoint to compare conversion rates and revenue across event and label types.

/v1/analytics/top-links

Returns branded links ranked by a selectable performance metric — clicks, conversions, or revenue. Use the sort_by parameter to control ranking. Use this endpoint to identify which links are driving the most conversion activity.

/v1/analytics/time-to-conversion

Returns a histogram showing the distribution of time elapsed between a click and the associated conversion event. Use this endpoint to understand how quickly visitors convert after clicking a branded link.

/v1/analytics/paths

Returns journey path data suitable for Sankey diagram visualization. Each path represents a sequence of events a visitor completed between click and conversion. Conversion nodes include the label value from rbly.convert() where available.