Skip to main content
Raw Markdown

Customer level report for a specific campaign

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

Get every customer name and order number related to an conversion value

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.

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

Conversion goal name.

campaignstringrequired

At least one of the following must be passed: campaign, ad_det, and ad_name. If you want to search this but the value is empty, please enter 'n/a'.

ad_setstringrequired

At least one of the following must be passed: campaign, ad_det, and ad_name. If you want to search this but the value is empty, please enter 'n/a'.

ad_namestringrequired

At least one of the following must be passed: campaign, ad_det, and ad_name. If you want to search this but the value is empty, please enter 'n/a'.

pageintegerrequired

The min is 1.

page_sizeintegerrequired

The range is 1 to 100.

Examples
JSON
{
  "start_date": "string",
  "end_date": "string",
  "model": "first",
  "goal": "purchase",
  "campaign": "string",
  "ad_set": "string",
  "ad_name": "string",
  "page": 1,
  "page_size": 20
}

Responses

Body

application/json
codeintegerrequired
messagestringrequired
dataobjectrequired
Child fields
totalintegerrequired
page_sizeintegerrequired
recordsarray [object]required
Child fields
customerstring

Customer name.

new_customerstring

A value of 'Yes' or 'No' indicates whether the customer is a new one.

conversion_creditnumber
orderstring

Order name.

attributed_valuenumber
conversion_datestring

The time zone is your store settings.

Response Headers