Skip to developer documentation
Attriboo
Start free
Browse developer documentation
OpenAPI JSONFull Markdown referenceMCP tool referenceCLI command referenceHelp center
API documentation / Reports

Reports

Funnels

Read independent standard stages, list saved definitions, or inspect an ordered saved funnel.

GET/api/v1/stats/funnels

Access: Workspace key or OAuth analytics:read · Permission details

Query parameters

Query parameters
FieldTypeDescription
sitestringWebsite ID or domain. Required when the workspace has more than one website.
periodstringUTC date selection. from and to override period.

Values: realtime, today, yesterday, 7d, 30d, 90d, 12m, wtd, mtd, qtd, ytd, all.

Default: 30d.

fromstringInclusive start date. Supply to as well.
tostringInclusive end date. Supply from as well.
comparestringComparison range.

Values: previous_period, mom, qoq, yoy, none.

Default: previous_period.

modelstringHow recorded sources share revenue credit.

Values: first_touch, last_touch, linear, time_decay.

Default: first_touch.

filtersstringURL-encoded JSON array of up to twenty visitor filters, for example [{"dim":"country","op":"is","value":"US"}]. Dimensions: source, channel, campaign, entry_page, page, hostname, country, device, browser, os, goal. Operators: is, is_not. Values are exact strings up to 500 characters. All filters must match the visitor across available history; report dates then select activity for that cohort. Unmatched payments are excluded. Crawler counts remain website-wide; spend requires every filter to be source/channel/campaign. Preserve filters when paging.
limitintegerRow limit for reports that support it.

Default: 50.

cursorstringOpaque next_cursor from the previous page. Preserve the original website, report, dates, model and funnel selection. Never construct a cursor.
funnelstringOmit for standard stages; saved lists definitions; a saved funnel UUID reads its exact ordered results.

Request examples

Examples run from your server or terminal. Configure ATTRIBOO_TOKEN privately for authenticated requests. Replace example website IDs and values with your own. The examples make real requests when you run them.

cURL request
curl "https://www.attriboo.com/api/v1/stats/funnels?site=site_example&from=2026-10-01&to=2026-10-07&compare=none" \
  -H "Authorization: Bearer $ATTRIBOO_TOKEN"

Response

Illustrative response. Fields below are inside the data object. Optional coverage, notes and continuation fields vary by report.

Response fields
FieldTypeDescription
siteobjectWebsite ID, domain and currency.
periodobjectResolved UTC boundaries; to is the exclusive timestamp after the selected end date.
steps_definitionarrayStandard stage labels, when no saved funnel is selected.
kindstringsaved_definitions or saved for a selected saved-funnel request.
definitionobjectExact saved funnel definition when funnel=ID.
rowsarrayOrdered saved-funnel results when funnel=ID; label, visitors, pctOfFirst, pctOfPrevious, revCents and topSource.
funnelsarrayStandard cohorts, or saved definitions when funnel=saved. For funnel=ID use definition and rows instead.
next_cursorstring | nullWhen provided, pass this value to continue; null means the last page. Some small-site reports omit this field.
coverageobjectWhen provided, describes completeness, snapshot time and row coverage. Row limits apply to this page, not to headline totals.

site fields

site nested fields
FieldTypeDescription
idstringWebsite ID.
domainstringWebsite domain.
currencystringThree-letter currency.

period fields

period nested fields
FieldTypeDescription
fromstringInclusive UTC start.
tostringExclusive UTC end.
labelstringHuman-readable date selection.
comparestringComparison selection.
attribution_modelstringRevenue-credit model.

funnels[] fields

funnels nested fields
FieldTypeDescription
namestringCohort name.
visitorsintegerEntry cohort visitors.
buyersintegerBuyers in the cohort.
revenueintegerCohort revenue in cents.
conversion_ratenumberBuyer percentage.
stepsarrayIndependent stage counts, with step, visitors, pct_of_entry and drop_off_pct.
JSON response
{
  "status": "success",
  "data": {
    "site": {
      "id": "site_example",
      "domain": "shop.example.com",
      "currency": "USD"
    },
    "period": {
      "from": "2026-10-01T00:00:00.000Z",
      "to": "2026-10-08T00:00:00.000Z",
      "label": "Custom",
      "compare": "none",
      "attribution_model": "first_touch"
    },
    "funnels": [
      {
        "name": "All traffic",
        "visitors": 100,
        "buyers": 4,
        "revenue": 20000,
        "conversion_rate": 4,
        "steps": [
          {
            "step": "Visited the site",
            "visitors": 100,
            "pct_of_entry": 100,
            "drop_off_pct": 0
          },
          {
            "step": "Viewed 2+ pages",
            "visitors": 60,
            "pct_of_entry": 60,
            "drop_off_pct": 40
          },
          {
            "step": "Completed a goal",
            "visitors": 15,
            "pct_of_entry": 15,
            "drop_off_pct": 75
          },
          {
            "step": "Purchased",
            "visitors": 4,
            "pct_of_entry": 4,
            "drop_off_pct": 73.3
          }
        ]
      }
    ]
  }
}

List saved definitions

cURL request
curl "https://www.attriboo.com/api/v1/stats/funnels?site=site_example&from=2026-10-01&to=2026-10-07&compare=none&funnel=saved" \
  -H "Authorization: Bearer $ATTRIBOO_TOKEN"
JSON response
{
  "status": "success",
  "data": {
    "site": {
      "id": "site_example",
      "domain": "shop.example.com",
      "currency": "USD"
    },
    "kind": "saved_definitions",
    "funnels": [],
    "next_cursor": null,
    "coverage": {
      "complete": true,
      "total_rows": 0,
      "returned_rows": 0
    }
  }
}

Read an ordered saved funnel

cURL request
curl "https://www.attriboo.com/api/v1/stats/funnels?site=site_example&from=2026-10-01&to=2026-10-07&compare=none&funnel=YOUR_SAVED_FUNNEL_UUID" \
  -H "Authorization: Bearer $ATTRIBOO_TOKEN"
JSON response
{
  "status": "success",
  "data": {
    "site": {
      "id": "site_example",
      "domain": "shop.example.com",
      "currency": "USD"
    },
    "kind": "saved",
    "period": {
      "from": "2026-10-01T00:00:00.000Z",
      "to": "2026-10-08T00:00:00.000Z",
      "label": "Custom",
      "compare": "none",
      "attribution_model": "first_touch"
    },
    "definition": {
      "id": "11111111-1111-4111-8111-111111111111",
      "name": "Checkout",
      "steps": [
        {
          "kind": "page",
          "match": "equals",
          "value": "/pricing"
        },
        {
          "kind": "purchase"
        }
      ]
    },
    "rows": [
      {
        "label": "Visited /pricing",
        "visitors": 100,
        "pctOfFirst": 100,
        "pctOfPrevious": 100,
        "revCents": 20000,
        "topSource": "Google Organic"
      },
      {
        "label": "Purchased",
        "visitors": 4,
        "pctOfFirst": 4,
        "pctOfPrevious": 4,
        "revCents": 20000,
        "topSource": "Google Organic"
      }
    ],
    "coverage": {
      "complete": true,
      "total_rows": 2,
      "returned_rows": 2
    }
  }
}

Behavior and limits

Money is integer cents in site.currency. Percentages use a 0–100 scale.

Standard stages independently count entry-cohort members; they do not require the stages to happen in order.

funnel=saved returns kind: saved_definitions, funnels, next_cursor and coverage. Each definition includes id, name and steps.

funnel=ID returns kind: saved, period, definition, rows and coverage. Each ordered row has label, visitors, pctOfFirst, pctOfPrevious, revCents and topSource. Saved funnels have two to eight steps; a selected funnel has no cursor.

Definitions are read-only through the public API. Create and edit them in the dashboard.

Errors and retriesPagination and completenessOpenAPI JSON