Skip to main content
Raw Markdown

Get attribution report

POST/{version}/api/all-attribution/get-list

Obtain a detailed attribution report

Rate limits: 5 requests per second.

version: v2-4-2.

Request

Path Params

versionstringrequired
examplev2-4-2

Header Params

ApiKeystringrequired
default{{ApiKey}}
exampleYOUR_API_KEY

Body Params

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.

dimensionsarray [string]required

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

Child fields
string

campaign

channel

source

medium

landing_page

modelstringrequired

First click

Last click

Linear

Position

Full Impact

For other values, please refer to the “name” section in the API documentation (https://developer.attribuly.com/api-429980012)

goalstringrequired

purchase

add_to_cart

ordersarray [object]

the default order is conversions desc.

Child fields
columnstring

conversions

new_lead_conversions

conversion_value

spend

clicks

ad_conversion_value

impressions

roas

ad_roas

cpa

cpm

cpc

net_profit

net_margin

orderstring

asc

desc

pageintegerrequired

page 1

page_sizeintegerrequired

min:1,max:100.

Examples
JSON
{
  "start_date": "2026-03-01",
  "end_date": "2026-03-18",
  "dimensions": [
    "channel"
  ],
  "model": "first",
  "goal": "purchase",
  "orders": [
    {
      "column": "conversions",
      "order": "desc"
    }
  ],
  "page": 1,
  "page_size": 20
}

Responses

Body

application/json
codeintegerrequired

1:success; other:failed

messagestringrequired

message

dataobjectrequired
Child fields
totalintegerrequired

total

page_sizeintegerrequired

page size

recordsarray [object]required
Child fields
campaignstring

campaign

channelstring

channel

sourcestring

source

platformstring

platform

mediumstring

medium

landing_pagestring

conversions

conversionsnumberrequired

new lead conversions

new_lead_conversionsnumberrequired

conversion value

conversion_valuenumberrequired

spend

spendnumberrequired

clicks

clicksnumberrequired
ad_conversion_valuenumberrequired

ad conversion value

impressionsnumberrequired

impressions

roasnumberrequired

roas

ad_roasnumberrequired

ad roas

cpanumberrequired

cost per action

cpmnumberrequired

cost per click

cpcnumberrequired

cost per mille

net_profitnumberrequired

net profit

net_marginnumberrequired

net margin

ltvnumberrequired

lifetime value

new_customer_conversion numberrequired

new customer conversion

01KYC75J8TJK9ZS2YKJYCTJY6Dstring

Response Headers