GET
/
reports
/
sub_ids
Get sub_ids report
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/affiliate/reports/sub_ids \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "sub_id": "<string>",
    "id": "<string>",
    "data": {
      "clicks_count": 123,
      "revenue_amount": 123,
      "promoter_earnings_amount": 123,
      "referrals_count": 123,
      "customers_count": 123,
      "sales_count": 123,
      "refunds_count": 123,
      "cancelled_customers_count": 123,
      "referrals_to_customers_cr": 123,
      "clicks_to_customers_cr": 123,
      "clicks_to_referrals_cr": 123
    },
    "sub_data": [
      {
        "period": "<string>",
        "id": "<string>",
        "data": {
          "clicks_count": 123,
          "revenue_amount": 123,
          "promoter_earnings_amount": 123,
          "referrals_count": 123,
          "customers_count": 123,
          "sales_count": 123,
          "refunds_count": 123,
          "cancelled_customers_count": 123,
          "referrals_to_customers_cr": 123,
          "clicks_to_customers_cr": 123,
          "clicks_to_referrals_cr": 123
        }
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
columns
enum<string>[]
required
​
q
string
​
group_by
enum<string>
required
Available options:
day,
week,
month,
year
​
start_date
string<date-time>
required
​
end_date
string<date-time>
required
​
sorting
object

Response

Successful response

The response is of type object[].