Order: total conversion journey

Endpoint URL

• https://data.api.attribuly.com

Version

• v2-4-2

Rate limits

• 20 requests per second

Tips

• The data returned by the API is generally 10-30 minutes old, and we are sorry that we cannot provide real-time data for querying.

• Each API request can only query one order, and we are sorry that we cannot provide bulk order queries at this time.

Order's total conversion journey

POST/{version}/api/order/event

Path parameters

version*string

Example: "v2-4-2"

Header parameters

Body

application/json

order_id*string

The ID of the order

page*integer

page_size*integer

min:1;max:100

Response

200

Success

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('/{version}/api/order/event', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "order_id": "text",
      "page": 0,
      "page_size": 0
    }),
});
const data = await response.json();

Response

200

{
  "code": 0,
  "message": "text",
  "data": {
    "order_id": "text",
    "total": 0,
    "page": 0,
    "page_size": 0,
    "events": [
      {
        "event_id": "text",
        "event_at": "text",
        "event_page_url": "text",
        "event_page_title": "text",
        "event_page_referrer": "text",
        "event_page_ip": "text",
        "event_page_user_agent": "text",
        "event_campaign": "text",
        "event_source": "text",
        "event_medium": "text",
        "event_type": "text",
        "creator": {
          "creator_id": "text",
          "creator_name": "text",
          "creator_url": "text",
          "creator_short_url": "text",
          "creator_origin_url": "text",
          "creator_type": "text",
          "creator_cost": 0,
          "creator_source": "text",
          "creator_campaign": "text",
          "creator_platform": "text"
        },
        "ad": {
          "account_id": "text",
          "account_name": "text",
          "campaign_id": "text",
          "campaign_name": "text",
          "set_id": "text",
          "set_name": "text",
          "ad_id": "text",
          "ad_name": "text",
          "ad_platform": "text",
          "keyword": "text"
        },
        "email": {
          "receiver_email": "text",
          "email_platform": "text"
        },
        "social_media": {
          "social_media_platform": "text"
        },
        "organic_search": {
          "organic_search_platform": "text",
          "organic_search_query": "text"
        },
        "products": [
          {
            "other_product_id": "text",
            "other_variant_id": "text",
            "product_name": "text",
            "variant_name": "text",
            "final_name": "text",
            "currency": "text",
            "price": 0,
            "shop_currency_price": 0,
            "quantity": 0
          }
        ],
        "cart_viewed": {
          "currency": "text",
          "total_price": 0,
          "shop_currency_total_price": 0,
          "total_quantity": 0
        },
        "checkout_started": {
          "other_order_id": "text",
          "other_order_no": "text",
          "currency": "text",
          "total_price": 0,
          "shop_currency_total_price": 0
        },
        "checkout_completed": {
          "other_order_id": "text",
          "other_order_no": "text",
          "currency": "text",
          "total_price": 0,
          "shop_currency_total_price": 0
        },
        "payment_info_submitted": {
          "other_order_id": "text",
          "other_order_no": "text",
          "currency": "text",
          "total_price": 0,
          "shop_currency_total_price": 0
        },
        "search_submitted": {
          "search_query": "text"
        }
      }
    ]
  }
}