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

Path parameters

versionstringRequiredExample: v2-4-2

Header parameters

ApiKeystringOptional

api secret key

Body

application/json

order_idstringRequired

The ID of the order

pageintegerRequired

page_sizeintegerRequired

min:1;max:100

Responses

200

Success

application/json

post

/{version}/api/order/event

HTTPcURLJavaScriptPython

POST /{version}/api/order/event HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "order_id": "text",
  "page": 1,
  "page_size": 1
}

200

Success

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "order_id": "5154899656917",
    "shop_currency": "USD",
    "total": 1,
    "page": 1,
    "page_size": 20,
    "events": [
      {
        "event_id": "9yc5v001000cu0rlqh770iye005p087h",
        "event_at": "2023-03-29 08:26:42",
        "event_page_url": "https://test-xq.myshopify.com/?dm_cam=23852036112060436&dm_grp=23852036112150436&dm_ad=23852036112230436&dm_net=facebook&fbclid=IwAR0BW3u3sOIHRq_R5CfZIUQkie2pWM1Jg0Yc7FHQR5eUWP1nJnDU0UKrRMc",
        "event_page_title": "Test-Dmap",
        "event_page_referrer": "",
        "event_page_ip": "103.105.49.145",
        "event_page_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36",
        "event_campaign": "Standard Shopping-cam-0103",
        "event_source": "facebook",
        "event_medium": "ads",
        "event_type": "ad",
        "creator": null,
        "ad": {
          "account_id": "628838465542582",
          "account_name": "Xq Cecile",
          "campaign_id": "23852036112060436",
          "campaign_name": "Standard Shopping-cam-0802",
          "set_id": "23852036112150436",
          "set_name": "Standard Shopping-adset",
          "ad_id": "23852036112230436",
          "ad_name": "Standard Shopping-ad",
          "ad_platform": "facebook",
          "keyword": ""
        },
        "email": null,
        "social_media": null,
        "organic_search": null,
        "products": null,
        "cart_viewed": null,
        "checkout_started": null,
        "checkout_completed": null,
        "payment_info_submitted": null,
        "search_submitted": null
      }
    ]
  }
}