Querying orders by a campaign

POST/{version}/api/all-attribution/info

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 conversion_at desc.

Child fields

columnstring

conversion_at

orderstring

asc

desc

pageintegerrequired

page 1

page_sizeintegerrequired

min:1,max:20

unique_featurearray [object]required

Child fields

campaignstringrequired

campaign name

Examples

JSON

{
  "start_date": "2026-03-01",
  "end_date": "2026-03-18",
  "dimensions": [
    "campaign"
  ],
  "model": "Linear",
  "goal": "purchase",
  "orders": [
    {
      "column": "conversion_at",
      "order": "desc"
    }
  ],
  "unique_feature": [
    {
      "campaign": "my google campaign name"
    }
  ],
  "page": 1,
  "page_size": 20
}

Responses

Body

application/json

codeintegerrequired

messagestringrequired

dataobjectrequired

Child fields

totalintegerrequired

page_sizeintegerrequired

recordsarray [object]required

Child fields

event_final_user_idstringrequired

target_event_idstringrequired

target_event_typestringrequired

conversion_atstringrequired

Order created at

conversionsintegerrequired

conversion_valuenumberrequired

conversion_countintegerrequired

user_namestringrequired

user_emailstringrequired

order_numberstringrequired

order_idstringrequired

order_namestringrequired

is_repeatbooleanrequired

is_new_customerintegerrequired

total_pricenumberrequired

Total price

total_discountintegerrequired

Total discount

quantityintegerrequired

Quantity

order_itemsarray [object]required

Product list

Child fields

product_idstringrequired

Product id

variant_idstringrequired

Variant id

namestringrequired

Product name

titlestringrequired

Product title

skustringrequired

Sku

quantityintegerrequired

Quantity

total_pricenumberrequired

Total price

total_discountintegerrequired

Total Discount

Response Headers

Environmenthttps://data.api.attribuly.com

Open in Apifox

Request Example

cURL

curl --request POST \
+  --url 'https://data.api.attribuly.com/v2-4-2/api/all-attribution/info' \
+  --header 'ApiKey: YOUR_API_KEY' \
+  --header 'Content-Type: application/json' \
+  --data '{
  "start_date": "2026-03-01",
  "end_date": "2026-03-18",
  "dimensions": [
    "campaign"
  ],
  "model": "Linear",
  "goal": "purchase",
  "orders": [
    {
      "column": "conversion_at",
      "order": "desc"
    }
  ],
  "unique_feature": [
    {
      "campaign": "my google campaign name"
    }
  ],
  "page": 1,
  "page_size": 20
}'

Response Example

JSON

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "total": 3,
    "page_size": 20,
    "records": [
      {
        "event_final_user_id": "702",
        "target_event_id": "",
        "target_event_type": "",
        "conversion_at": "2026-04-15 18:45:17",
        "conversions": 1,
        "conversion_value": 55.88,
        "conversion_count": 0,
        "user_name": "Eulalie Perseus",
        "user_email": "EulaliePerseus@example.com",
        "order_number": "1582",
        "order_id": "6717168124117",
        "order_name": "X1582-A",
        "is_repeat": false,
        "is_new_customer": 1,
        "total_price": 55.88,
        "total_discount": 0,
        "quantity": 3,
        "order_items": [
          {
            "product_id": "7897433309397",
            "variant_id": "43728958423253",
            "name": "APPLE PINK LADY ORGANIC - 1.0KG",
            "title": "APPLE PINK LADY ORGANIC",
            "sku": "apple-01",
            "quantity": 3,
            "total_price": 28.47,
            "total_discount": 0
          }
        ]
      },
      {
        "event_final_user_id": "701",
        "target_event_id": "",
        "target_event_type": "",
        "conversion_at": "2026-04-15 18:35:49",
        "conversions": 0.3333,
        "conversion_value": 49.08,
        "conversion_count": 0,
        "user_name": "Quintana Malloren",
        "user_email": "QuintanaMalloren@example.com",
        "order_number": "1581",
        "order_id": "6717161767125",
        "order_name": "X1581-A",
        "is_repeat": false,
        "is_new_customer": 1,
        "total_price": 147.26,
        "total_discount": 0,
        "quantity": 3,
        "order_items": [
          {
            "product_id": "7897486295253",
            "variant_id": "43729074487509",
            "name": "APPLE GRANNY SMITH BOX",
            "title": "APPLE GRANNY SMITH BOX",
            "sku": "",
            "quantity": 3,
            "total_price": 108,
            "total_discount": 0
          }
        ]
      },
      {
        "event_final_user_id": "701",
        "target_event_id": "",
        "target_event_type": "",
        "conversion_at": "2026-04-15 18:28:34",
        "conversions": 0.5,
        "conversion_value": 21.25,
        "conversion_count": 0,
        "user_name": "Quintana Malloren",
        "user_email": "QuintanaMalloren@example.com",
        "order_number": "1580",
        "order_id": "6717157245141",
        "order_name": "X1580-A",
        "is_repeat": false,
        "is_new_customer": 1,
        "total_price": 42.51,
        "total_discount": 0,
        "quantity": 2,
        "order_items": [
          {
            "product_id": "7889490018517",
            "variant_id": "43702138437845",
            "name": "180 DEGREES CHEESE BITES 150G",
            "title": "180 DEGREES CHEESE BITES 150G",
            "sku": "G-01",
            "quantity": 2,
            "total_price": 18.98,
            "total_discount": 0
          }
        ]
      }
    ]
  }
}