Get current user referral analytics

GET/v1/referral/me/analytics

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

periodstring

default: "30d"

Allowed:7d30d90d

Responses

200OK

click_to_signup_ratenumber<double>required

epc_idrinteger<int64>required

signup_to_paid_ratenumber<double>required

time_seriesReferralDataPoint[] | nullrequired

Show properties

Array of ReferralDataPoint

clicksinteger<int64>required

datestringrequired

paidinteger<int64>required

signupsinteger<int64>required

total_clicksinteger<int64>required

total_paid_conversionsinteger<int64>required

total_signupsinteger<int64>required

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/referral/me/analytics"

const response = await fetch("/v1/referral/me/analytics", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/referral/me/analytics",
)

Response

{
  "click_to_signup_rate": 0,
  "epc_idr": 0,
  "signup_to_paid_rate": 0,
  "time_series": [
    {
      "clicks": 0,
      "date": "string",
      "paid": 0,
      "signups": 0
    }
  ],
  "total_clicks": 0,
  "total_paid_conversions": 0,
  "total_signups": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}