Get a list of all attribution data

Endpoint URL

• https://data.api.attribuly.com

Version

• v2-4-2

Rate limits

• 5 requests per second

Tips

• The data returned by the API is generally 10-30 minutes old, and we are sorry that we cannot provide real-time data for querying.

Get a list of all attribution data

post

• Rate limits: 5 requests per second.

• version: v2-4-2.

Path parameters

versionstringRequiredExample: v2-4-2

Header parameters

ApiKeystringOptionalDefault: 1ioe4e61000ct21gpm1kqfez003pr7wzExample: 1ioe4e61000ct21gpm1kqfez003pr7wz

Body

start_datestringRequired

The start date range of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.

end_datestringRequired

The end date of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.If you want to see the data for 1970-01-01, please enter 1970-01-02.

dimensionsstring[]Required

The input quantity should not exceed 3, campaign/channel/source/medium/landing_page.

modelstringRequired

Attribution Model, first/last/linear/position.

goalstringRequired

Attribution goal, purchase/add_to_cart/checkout_start/payment_info_submitted.

pageintegerRequired

page_sizeintegerRequired

min:1,max:100.

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /{version}/api/all-attribution/get-list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "start_date": "2025-01-01",
  "end_date": "2025-01-02",
  "dimensions": [
    "campaign"
  ],
  "model": "first",
  "goal": "purchase",
  "orders": [
    {
      "column": "conversions",
      "order": "desc"
    }
  ],
  "page": 1,
  "page_size": 20
}

200Success

{
  "code": 1,
  "message": "succeed",
  "data": {
    "total": 0,
    "page_size": 0,
    "records": [
      {
        "campaign": "test-campaign",
        "channel": "test-campaign",
        "source": "",
        "platform": "",
        "medium": "",
        "landing_page": "",
        "conversions": 0,
        "new_lead_conversions": 0,
        "conversion_value": 0,
        "spend": 0,
        "clicks": 0,
        "ad_conversion_value": 0,
        "impressions": 0,
        "roas": 0,
        "ad_roas": 0,
        "cpa": 0,
        "cpm": 0,
        "cpc": 0,
        "net_profit": 0,
        "net_margin": 0
      }
    ]
  }
}