Tracking Api

Tracking sales and commissions

Assign sales and commissions to your promoters. To track sales and generate commissions correctly, you need to use this API call each time a non-zero amount sale is processed in your system, even if it comes from a recurring charge or one-time charge.

To avoid fraudulent sales, we don’t use JS conversion pixels to track sales, which are very unreliable and can be easily faked. Instead, we use server-side tracking for all sales to ensure that a sale is tracked only when you actually receive money in your billing account.

To maintain the same standards with the API, we recommend making the sale API call (this call) only when you receive confirmation of the sale from your billing provider, such as from a webhook, an IPN, or a success response from an API charge call.

You just need to pass the sale amount (before taxes) and we’ll take care of the rest. The commissions/rewards will be calculated based on that amount and the plan ID, in case you use the plan-level rewards feature.

Using email or UID parameters, we identify the lead/customer who generated the sale, which also helps us determine the promoter who owns the reward/commission.

The lead is added to our system either by the client signup tracking script when the user signs up or by calling the signup API endpoint. There is also the option to bypass the signup tracking by using TID or ref_id parameters, which will create the lead and assign the sale in one go.

If we don’t find the lead in our system, it means that the sale is not a referral sale and you’ll get a 204 response. You don’t have to identify which sale is from referrals and which is not; we’ll take care of that.

For zero-decimal currencies like JPY, amount and mrr parameters should be sent as whole values.

For other currencies, amount and mrr parameter values should be in cents, i.e., you will need to multiply the value by 100 before sending the request.

HTTP Request
POST https://v2.firstpromoter.com/api/v2/track/sale

POST

sale

curl --request POST \
  --url https://v2.firstpromoter.com/api/v2/track/sale \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "uid": "<string>",
  "event_id": "<string>",
  "amount": 123,
  "quantity": 123,
  "plan": "<string>",
  "currency": "<string>",
  "mrr": "<string>",
  "promo_code": "<string>",
  "tid": "<string>",
  "ref_id": "<string>",
  "skip_email_notification": true
}'

{
  "id": 45831949,
  "etype": "sale",
  "sale_amount": 2000,
  "original_sale_amount": 2000,
  "original_sale_currency": null,
  "event_id": null,
  "plan_id": null,
  "billing_period": null,
  "created_at": "2025-04-25T09:39:42.289Z",
  "referral": {
    "id": 29203686,
    "email": "[email protected]",
    "uid": null
  },
  "commissions": [
    {
      "id": 13533003,
      "status": "approved",
      "metadata": {},
      "is_self_referral": false,
      "commission_type": "sale",
      "created_by_user_email": null,
      "created_by_user_at": null,
      "sale_amount": 2000,
      "original_sale_amount": 2000,
      "original_sale_currency": null,
      "event_id": null,
      "plan_id": null,
      "tier": 1,
      "internal_note": null,
      "external_note": null,
      "unit": "cash",
      "fraud_check": "no_suspicion",
      "amount": 400,
      "is_paid": false,
      "is_split": false,
      "created_at": "2025-04-25T09:39:42Z",
      "status_updated_at": null,
      "promoter_campaign": {
        "id": 14850130,
        "campaign_id": 28004,
        "promoter_id": 8262622,
        "created_at": "2025-01-16T18:16:41Z",
        "promoter": {
          "id": 8262622,
          "email": "[email protected]",
          "name": "Test Promoter"
        },
        "campaign": {
          "id": 28004,
          "name": "Quinn Ramirez",
          "color": "#EC4899"
        }
      },
      "referral": {
        "id": 29203686,
        "email": "[email protected]",
        "uid": null
      },
      "reward": {
        "id": 157427,
        "name": "20% recurring commission"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys

Headers

Account-ID

string

required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Body

application/json

Response

200

application/json

Sale tracked successfully

The response is of type object.

Tracking leads and sign-ups Tracking refunds and negative commissions

curl --request POST \
  --url https://v2.firstpromoter.com/api/v2/track/sale \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "uid": "<string>",
  "event_id": "<string>",
  "amount": 123,
  "quantity": 123,
  "plan": "<string>",
  "currency": "<string>",
  "mrr": "<string>",
  "promo_code": "<string>",
  "tid": "<string>",
  "ref_id": "<string>",
  "skip_email_notification": true
}'

{
  "id": 45831949,
  "etype": "sale",
  "sale_amount": 2000,
  "original_sale_amount": 2000,
  "original_sale_currency": null,
  "event_id": null,
  "plan_id": null,
  "billing_period": null,
  "created_at": "2025-04-25T09:39:42.289Z",
  "referral": {
    "id": 29203686,
    "email": "[email protected]",
    "uid": null
  },
  "commissions": [
    {
      "id": 13533003,
      "status": "approved",
      "metadata": {},
      "is_self_referral": false,
      "commission_type": "sale",
      "created_by_user_email": null,
      "created_by_user_at": null,
      "sale_amount": 2000,
      "original_sale_amount": 2000,
      "original_sale_currency": null,
      "event_id": null,
      "plan_id": null,
      "tier": 1,
      "internal_note": null,
      "external_note": null,
      "unit": "cash",
      "fraud_check": "no_suspicion",
      "amount": 400,
      "is_paid": false,
      "is_split": false,
      "created_at": "2025-04-25T09:39:42Z",
      "status_updated_at": null,
      "promoter_campaign": {
        "id": 14850130,
        "campaign_id": 28004,
        "promoter_id": 8262622,
        "created_at": "2025-01-16T18:16:41Z",
        "promoter": {
          "id": 8262622,
          "email": "[email protected]",
          "name": "Test Promoter"
        },
        "campaign": {
          "id": 28004,
          "name": "Quinn Ramirez",
          "color": "#EC4899"
        }
      },
      "referral": {
        "id": 29203686,
        "email": "[email protected]",
        "uid": null
      },
      "reward": {
        "id": 157427,
        "name": "20% recurring commission"
      }
    }
  ]
}

API Documentation

Batch Processes

Tracking Api

Referrals

Promoters

Promoter Campaigns

Commissions

Promo Codes

Payouts

Reports

Tracking sales and commissions

Authorizations

Headers

Body

Response