Channel/Campaign/Ad-set/Ad level ads attribution

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

Analyze your paid advertising performance across channels

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.

dimensionstringrequired

channel/campaign/ad_set/ad

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

Attribution goal: purchase/add_to_cart

pageintegerrequired

The min is 1.

page_sizeintegerrequired

The range is 1 to 100.

Examples

JSON

{
  "start_date": "string",
  "end_date": "string",
  "dimension": "channel",
  "model": "first",
  "goal": "purchase",
  "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

channelstring

channel

campaignstring

campaign

ad_setstring

ad set

ad_namestring

ad name

new_lead_conversionsnumber

Conversions of new lead.

conversionsnumber

Node conversions under corresponding attribution goal.

conversion_valueinteger

Node conversion value under corresponding attribution goal.

new_order_conversion_valuenumber

The conversion value of new order.

new_order_roasnumber

The new order of roas.

ad_net_conversion_valuenumber

The conversion value which pulled from ads manager.

ad_net_roasnumber

The roas which pulled from ads manager.

spendnumber

Spend is how much you’ve spent over a given period of time.

cpanumber

CPA=Spend/Purchase conversions.

roasnumber

ROAS=(Purchase conversion value/ Spend).

impressionsinteger

Total impressions within the time range. It‘s pulled from ads manager.

cpmnumber

CPM=(Spend/Impressions)*1000.

CPM stands for cost per 1,000 impressions.

clicksinteger

Numbers visitors click to your website.

cvrnumber

CVR=(Purchase conversions/Clicks)*100% CVR(conversion rate) is the percentage of link clicks to your website that resulted in a purchase.

cpcnumber

CPC=Spend/Clicks. CPC stands for cost per click.

ctrnumber

CTR=(Clicks/Impressions)*100%. CTR stands for click through rate.

outbound_clicksinteger

The number of clicks on links that take people off Meta technologies.

outbound_ctrnumber

Outbound CTR=(Outbound clicks/impressions)*100%. The percentage of times people saw your ad and performed an outbound click.

cost_per_outbound_clicknumber

Cost per outbound click=Spend/Outbound clicks. The average cost for each outbound click.

view_through_conversionsnumber

Based on Attribuly purchase conversions, add Facebook's view-through purchase conversions(1-day view).

view_through_conversion_valuenumber

Based on Attribuly purchase conversion value, add Facebook's view-through purchase conversion value(1-day view).

view_through_roasnumber

Purchase conversion value (Incl. view-through)/Spend.

profitnumber

Total sales-shipping-ad spend-product cost(COGS)-taxes-payment processing fees.

marginnumber

Net Profit / Sales x 100%.