Link Builder

POST/{version}/api/get/link-builder-analysis/list

Short links for marketing attribution

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.

pageintegerrequired

The min is 1.

page_sizeintegerrequired

The range is 1 to 100.

Examples

JSON

{
  "start_date": "2025-10-28",
  "end_date": "2026-01-06",
  "page": 1,
  "page_size": 10
}

Responses

Body

application/json

codeintegerrequired

messagestringrequired

dataobjectrequired

Child fields

totalintegerrequired

page_sizeintegerrequired

recordsarray [object]required

Child fields

tracking_linkstring

tracking link url

campaignstring

campaign

sourcestring

source

mediumstring

medium

landing_pagestring

landing page url

created_atstring

created at date

total_usersinteger

total users

new_usersinteger

new users

clicksinteger

clicks

purchaseinteger

purchase

purchase_conversion_valueinteger

purchase conversion value

add_to_cartinteger

add to cart

add_to_cart_conversion_valueinteger

add to cart conversion value

collection_viewinteger

collection view

search_submitinteger

search submit

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/get/link-builder-analysis/list' \
+  --header 'ApiKey: YOUR_API_KEY' \
+  --header 'Content-Type: application/json' \
+  --data '{
  "start_date": "2025-10-28",
  "end_date": "2026-01-06",
  "page": 1,
  "page_size": 10
}'

Response Example

JSON

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "total": 1,
    "page_size": 10,
    "records": [
      {
        "tracking_link": "https://s.attribuly.com/waakYXpb",
        "campaign": "0222",
        "source": "02",
        "medium": "022",
        "landing_page": "/",
        "created_at": "2025-12-23 06:28:10",
        "total_users": 0,
        "new_users": 0,
        "clicks": 0,
        "purchase": 0,
        "purchase_conversion_value": 0,
        "add_to_cart": 0,
        "add_to_cart_conversion_value": 0,
        "collection_view": 0,
        "search_submit": 0
      }
    ]
  }
}