Get a list of ad 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 ad attribution data

post

• Rate limits: 5 requests per second.

• version: v2-4-2.

Path parameters

versionstringRequiredExample: v2-4-2

Header parameters

ApiKeystringOptionalDefault: {{ApiKey}}Example: {{ApiKey}}

Body

application/json

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.

dimensionstringRequired

• channel
• campaign
• ad_set
• ad

modelstringRequired

Conversion model name.

goalstringRequired

Conversion goal name.

pageintegerRequired

The min is 1.

page_sizeintegerRequired

The range is 1 to 100.

Responses

200Success

application/json

post

/{version}/api/get/ad-analysis/list

HTTPcURLJavaScriptPython

POST /{version}/api/get/ad-analysis/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "start_date": "string",
  "end_date": "string",
  "dimension": "channel",
  "model": "first",
  "goal": "purchase",
  "page": 1,
  "page_size": 20
}

200Success

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "total": 1,
    "page_size": 20,
    "records": [
      {
        "channel": "applovin",
        "campaign": "",
        "ad_set": "",
        "ad_name": "",
        "new_lead_conversions": 0,
        "conversions": 0,
        "conversion_value": 0,
        "new_order_conversion_value": 0,
        "new_order_roas": 0,
        "ad_net_conversion_value": 0,
        "ad_net_roas": 0,
        "spend": 22497.21,
        "cpa": 0,
        "roas": 0,
        "impressions": 564551,
        "cpm": 39.84,
        "clicks": 0,
        "cvr": 0,
        "cpc": 0,
        "ctr": 0,
        "outbound_clicks": 0,
        "outbound_ctr": 0,
        "cost_per_outbound_click": 0,
        "view_through_conversions": 0,
        "view_through_conversion_value": 0,
        "view_through_roas": 0,
        "profit": -22497.21,
        "margin": 0
      }
    ]
  }
}