Skip to main content
Raw Markdown

Get total numbers

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

Get the total data.

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

Examples
JSON
{
  "start_date": "2025-01-01",
  "end_date": "2025-01-02",
  "dimensions": [
    "campaign"
  ],
  "model": "first",
  "goal": "purchase"
}

Responses

Body

application/json
codeintegerrequired

1:success; other:failed

messagestringrequired
dataobjectrequired
Child fields
conversionsnumberrequired

conversions

new_lead_conversionsnumberrequired

new lead conversions

conversion_valuenumberrequired

conversion value

spendnumberrequired

spend

clicksnumberrequired

clicks

ad_conversion_valuenumberrequired

ad conversion value

impressionsnumberrequired

impressions

roasnumberrequired

roas

ad_roasnumberrequired

ad roas

cpanumberrequired

cpa

cpmnumberrequired

cpm

cpcnumberrequired

cpc

net_profitnumberrequired

net profit

net_marginnumberrequired

net margin

ltvnumberrequired

ltv

Response Headers