Pixel API endpoints reference

All endpoints

Region and city breakdowns

/pixel/analytics/regions and /pixel/analytics/cities exist but always return 503, because visitor location is recorded at country level only. Use /pixel/analytics/countries, and don't retry those two.

A lower-level GET /pixel/metrics/{report} endpoint also exists for advanced integrations. The named endpoints above cover the common reports — if you need one that isn't listed, email support@admaxxer.com.

Report parameters

Each time-series row has ts, value, revenue_new, revenue_renewal and revenue_refund (the revenue columns are 0 unless the metric is revenue). Revenue is in major currency units — 89.5, not 8950 — and is summed as recorded, without currency conversion.

If from_date falls before the earliest day your plan's data retention keeps, the report starts at that day instead.

Filtering reports

Add filters to the query string of the pages, referrers, countries, devices, browsers and operating-systems reports. Each filter narrows the result further. The other reports don't apply them.

Choose how a filter matches with a prefix on its value. Separate several values with commas (up to 20 per filter). Matching is case-sensitive.

• Is (the default): country=US or country=US,CA. The is: prefix is optional.
• Is not: country=is_not:US.
• Contains: utm_campaign=contains:summer.

A filter the API can't apply is rejected with 400 unsupported_filter instead of being silently ignored, so you never get unfiltered numbers by mistake:

400 response for ?region=California

{
  "status": "error",
  "error": {
    "code": "unsupported_filter",
    "message": "region is not tracked at the pageview level. Filter by `country` instead.",
    "details": {
      "filter": "region",
      "supported": [
        "country",
        "device",
        "browser",
        "os",
        "referrer",
        "page",
        "utm_source",
        "utm_medium",
        "utm_campaign",
        "utm_term",
        "utm_content"
      ]
    }
  },
  "meta": {
    "request_id": "req_…"
  }
}

Pagination

GET /pixel/websites returns up to limit websites (default 100, maximum 1,000), newest first. While pagination.has_more is true, send pagination.next_cursor back as cursor to get the next page. Treat cursors as opaque; an invalid cursor starts again from the first page.

Sending data from your server

Use the write endpoints where the browser pixel can't run. To tie a server-side record to the visitor the pixel saw, read the visitor ID in the browser with window.admaxxer.getVisitorId(), pass it to your server with the order or sign-up, and send it as visitor_id. Without a visitor_id, Admaxxer creates a new visitor for that record.

Copy website_id exactly

Write calls don't check website_id against your workspace. A record sent with a mistyped website ID is accepted but won't appear in any report, so copy the ID from GET /pixel/websites.

accepted: true means the record was queued for writing; it shows up in reports shortly afterwards. Timestamps take Unix time in milliseconds or an ISO-8601 string, and default to the time of the request.

POST /pixel/payments

Returns accepted, visitor_id and transaction_id.

POST /pixel/goals

Returns accepted, visitor_id and goal_name.

POST /pixel/events

Returns accepted, visitor_id and session_id.

POST /pixel/identify

Returns accepted and visitor_id.

Saved segments

Segments are named filter sets you store for a website and fetch back to reuse in report requests. Admaxxer keeps the filters object exactly as you send it.

Segments use the website's id

Segment calls identify the website by its id (a UUID) from GET /pixel/websites — not by the admx_ website ID the reports use. Passing the admx_ ID here returns an error.

• GET /pixel/segments?website_id={id} — list a website's segments. Without website_id the call returns 400 invalid_website.
• POST /pixel/segments with website_id, name (1–200 characters, unique per website) and filters (an object, default {}) — returns 201 and the new segment. A name already in use returns 409 duplicate_name; a website outside your workspace returns 404 not_found.
• PATCH /pixel/segments/{id} with name, filters or both — sending neither returns 400 empty_patch.
• DELETE /pixel/segments/{id} — returns deleted: true and the segment's id.
• POST /pixel/segments/{id}/apply — returns the stored filters for you to turn into query parameters.

Examples

List your websites

curl "https://admaxxer.com/api/v1/pixel/websites?limit=1" \
  -H "Authorization: Bearer $ADMAXXER_API_KEY"

{
  "status": "success",
  "data": [
    {
      "id": "6f1c2a7e-3b4d-4e5f-9a8b-1c2d3e4f5a6b",
      "websiteId": "admx_Xq3vN8kLp2RtY7wZb4cD9eFg",
      "allowedDomains": ["example.com"],
      "createdAt": "2026-04-17T09:30:12.418Z"
    }
  ],
  "meta": { "request_id": "req_2b6f0a3e-5d1c-4e8b-9f7a-0c3d6e9b2a14" },
  "pagination": { "has_more": true, "next_cursor": "eyJ0cyI6…" }
}

Top pages for US visitors, excluding newsletter traffic

curl "https://admaxxer.com/api/v1/pixel/analytics/pages?website_id=admx_your_site_id&from_date=2026-09-01&to_date=2026-09-30&country=US&utm_source=is_not:newsletter&limit=3" \
  -H "Authorization: Bearer $ADMAXXER_API_KEY"

{
  "status": "success",
  "data": {
    "data": [
      { "path": "/", "views": "4210", "sessions": "2984", "bounces": "1702", "bounce_rate": 57.04, "avg_time_seconds": 41.3 },
      { "path": "/pricing", "views": "1388", "sessions": "1017", "bounces": "402", "bounce_rate": 39.53, "avg_time_seconds": 68.9 },
      { "path": "/blog/attribution-guide", "views": "912", "sessions": "804", "bounces": "610", "bounce_rate": 75.87, "avg_time_seconds": 22.4 }
    ],
    "meta": [],
    "rows": 3,
    "statistics": { "elapsed": 0.018, "rows_read": 61505, "bytes_read": 2471088 },
    "data_status": "ok"
  },
  "meta": { "request_id": "req_8e3a1f6c-2b7d-4c09-a5e4-7f1b9d0c3e52" }
}

bounce_rate is a percentage and avg_time_seconds is in seconds. Counts such as views are strings so large values keep full precision.

Record a payment from your server

curl -X POST https://admaxxer.com/api/v1/pixel/payments \
  -H "Authorization: Bearer $ADMAXXER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "website_id": "admx_your_site_id",
    "transaction_id": "order_10482",
    "amount": 89.5,
    "currency": "USD",
    "visitor_id": "3f9c1b2e-8a47-4d1e-9b6a-2c5e7f0d1a93"
  }'

{
  "status": "success",
  "data": {
    "accepted": true,
    "visitor_id": "3f9c1b2e-8a47-4d1e-9b6a-2c5e7f0d1a93",
    "transaction_id": "order_10482"
  },
  "meta": { "request_id": "req_1b7e9d42-6c3a-4f85-a0d2-8e4c7b9f1a36" }
}

Frequently asked questions

Related guides

• Pixel API overview — Base URL, first request and response format.
• Authentication — API keys and the scope each endpoint needs.
• Rate limits — 60 requests per minute per workspace.
• Errors — Every error code these endpoints return.
• API keys guide — Step-by-step walkthrough of Settings › API Keys.
• Developer reference — The wider developer documentation for Admaxxer.