TrackReward API Reference

Server-to-server tracking

These are separate third-party endpoints. They do not change the existing tracker routes or controller. Send the account ID in the JSON body and the API key from Profile → Settings in the X-API-Key header.

TrackReward uses the account ID to locate the merchant tenant and its configured domain before the request reaches the existing tracking logic. Your third-party service should call the TrackReward API base URL; it does not need to know the tenant database.

X-API-Key: <profile-api-key>
Content-Type: application/json

API categories

Sales tracking example

Call this from your server after a successful payment. Use either customer_email or customer_uid, and use a unique event value for every sale.

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/track-sale' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "customer_email": "buyer@example.com",
    "plan": "pro",
    "amount": "49.00",
    "event": "order_12345",
    "affiliate_code": "AFFILIATE_CODE",
    "track_id": "TRACKING_ID",
    "quantity": 1
  }'

Required sale fields are account_id, plan, amount, event, and either customer identifier. Use affiliate_code and track_id, or a valid coupon, to attribute the sale.

Tracking request fields

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/get-data' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "account_url": "https://store.example.com",
    "affiliate_code": "AFFILIATE_CODE"
  }'

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/track-visit' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "affiliate_code": "AFFILIATE_CODE",
    "page_url": "https://store.example.com/pricing",
    "refferrer_url": "https://affiliate.example.com/review",
    "track_id": "visitor_12345",
    "domain": "store.example.com"
  }'

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/track-signup' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "affiliate_code": "AFFILIATE_CODE",
    "track_id": "visitor_12345",
    "page_url": "https://store.example.com/signup",
    "refferrer_url": "https://affiliate.example.com/review",
    "customer_email": "buyer@example.com",
    "customer_uid": "customer_12345",
    "plan": "pro"
  }'

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/track-sale' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "customer_email": "buyer@example.com",
    "customer_uid": "customer_12345",
    "plan": "pro",
    "amount": "49.00",
    "event": "order_12345",
    "affiliate_code": "AFFILIATE_CODE",
    "track_id": "visitor_12345",
    "quantity": 1
  }'

curl -X POST 'https://trackreward.com/api/third-party/v1/tracker/track-charge' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <profile-api-key>' \
  -d '{
    "account_id": "<account-id>",
    "customer_email": "buyer@example.com",
    "customer_uid": "customer_12345",
    "page_url": "https://store.example.com/checkout",
    "refferrer_url": "https://affiliate.example.com/review",
    "amount": 99.95,
    "event": "order_12345",
    "affiliate_code": "AFFILIATE_CODE",
    "track_id": "visitor_12345",
    "quantity": 2
  }'

Responses and errors

Successful tracking requests return HTTP 200 with a message. Invalid credentials return 401, an unknown account returns 404, and validation failures return 422 with Laravel’s validation error object.

{
  "message": "Sales tracked successfully."
}