SourceLoop API

Read your attribution data, write conversions back from your backend, and automate reporting. 24 endpoints across 12 resources, one bearer token.

Quickstart

Create a key in the app under Settings, Developers, API keys, then ask for a number:

curl -s "https://app.sourceloop.ai/api/v1/metrics?website=acme.com&period=last%2030%20days&metrics=conversions,revenue" \
  -H "Authorization: Bearer $SOURCELOOP_API_KEY"

Every response echoes the timezone, the currency and the window it resolved, plus a definitions block explaining each metric, so a figure from this API is never ambiguous about what it counts.

Authentication How to create an API key, send it, scope it to the right permissions, and keep it out of your browser bundle. Errors and rate limits The error format, what each status means, the per-plan request budget, and how to back off before you are refused. Pagination and versioning How to page through list endpoints with cursors, what the meta block tells you, and how the API changes over time. Data provenance and PII Where each field came from, why that matters before you automate on it, and how personal data is masked when a key lacks permission to read it.

All endpoints

Base URL https://app.sourceloop.ai/api/v1. Every endpoint takes a bearer token; the permission column shows the scope a key needs.

Workspace

Check what a key can do, list the websites it covers, and read the semantic layer of metrics and dimensions.

Endpoint	Method	Path
Get key info What this key is and what it can do	GET	`/v1/me`
Get schema Every metric, dimension and filter operator	GET	`/v1/schema`
List websites Websites this key can reach	GET	`/v1/websites`

Metrics

Aggregated metrics, breakdowns and timeseries across any dimension, with the attribution model you choose.

Endpoint	Method	Path	Permission
Get metrics Aggregate metrics, breakdowns and timeseries	GET	`/v1/metrics`	`metrics:read`

Contacts

The lead ledger: list contacts with their first and last touch, read one, and pull the full visitor journey behind it.

Endpoint	Method	Path	Permission
List contacts Your contacts, one row per conversion	GET	`/v1/contacts`	`conversions:read`
Get contact One conversion, with its deals and value history	GET	`/v1/contacts/{id}`	`conversions:read`
Update contact Write an outcome back	PATCH	`/v1/contacts/{id}`	`conversions:write`
Get contact journey Every session behind one conversion, in order	GET	`/v1/contacts/{id}/journey`	`conversions:read`

Companies

Company records with firmographics, pipeline rollups and attribution, whether or not a CRM is connected.

Endpoint	Method	Path	Permission
List companies Companies, with firmographics, pipeline rollups and attribution	GET	`/v1/companies`	`companies:read`
Get company One company, with its deals and its people	GET	`/v1/companies/{id}`	`companies:read`
Update company Correct a company's firmographics	PATCH	`/v1/companies/{id}`	`companies:write`
Get company journey The account journey: everyone at the company, merged	GET	`/v1/companies/{id}/journey`	`companies:read`

Deals

CRM deals and the pipelines they move through, including values, stages and write-back.

Endpoint	Method	Path	Permission
List deals Your pipeline, with the attribution we computed for it	GET	`/v1/deals`	`deals:read`
List pipelines Pipelines and their stages, in order	GET	`/v1/pipelines`	`deals:read`
Get deal One deal, with its people and its history	GET	`/v1/deals/{id}`	`deals:read`
Update deal Move a deal, or change its value, in your CRM	PATCH	`/v1/deals/{id}`	`deals:write`
Get deal journey The marketing behind one deal	GET	`/v1/deals/{id}/journey`	`deals:read`

Events

Send server-side events for anything the browser cannot see: OAuth callbacks, payment webhooks, queue workers.

Endpoint	Method	Path	Permission
Send events Send server-side events	POST	`/v1/events`	`events:write`

Spend, impressions and clicks from the connected ad platforms, joined to the conversions they produced.

Endpoint	Method	Path	Permission
Get ad performance Ad platform spend and delivery	GET	`/v1/ads/performance`	`metrics:read`

Attribution

How much of your converted traffic carries usable attribution, and where the gaps are.

Endpoint	Method	Path	Permission
Get attribution coverage How much revenue attribution explains, and why not	GET	`/v1/attribution/coverage`	`metrics:read`

Funnels

Step-by-step conversion funnels with drop-off between stages.

Endpoint	Method	Path	Permission
Get funnel Stage-to-stage conversion	GET	`/v1/funnels`	`metrics:read`

Paths

The touch sequences visitors take before they convert.

Endpoint	Method	Path	Permission
Get paths The touch sequences that lead to outcomes	GET	`/v1/paths`	`metrics:read`

Products

Revenue and conversions broken down by product or plan.

Endpoint	Method	Path	Permission
Get products Per-product sales for a connected store	GET	`/v1/products`	`metrics:read`

Changes

What changed since your last run. The incremental endpoint automations poll instead of refetching a window.

Endpoint	Method	Path	Permission
List changes What changed since your last run	GET	`/v1/changes`	`conversions:read`

Guides

Send server-side conversions Attribute events your browser never sees, such as payment webhooks, OAuth callbacks and queue workers, by stitching them to the visitor who caused them. Sync data incrementally Poll what changed since your last run instead of refetching a window and diffing, and avoid reacting to your own writes. Automate client reporting Pull the same numbers for every client website with one credential, into a spreadsheet, a BI tool, or a scheduled agent. MCP server Connect the same data to Claude, ChatGPT or Cursor and ask questions of it in natural language.

Machine-readable

The OpenAPI specification behind every page in this reference is served at /help/api/openapi.json. Point Postman, an SDK generator or an agent at it and you have the whole API without crawling these pages. Each page also has a markdown twin: append .md to any URL under /help/api/.