Partner

Get Performance Timeseries

GET
/partner/performance-timeseries

Authorization

appToken read
AuthorizationBearer <token>

App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.

In: header

Scope: read

Query Parameters

userId*string

Identifier of the partner user whose performance timeseries is requested

Formatuuid
indicator*string

KPI to build the daily series for. Deposits and withdrawals are client-centric: they cover all operations of the clients currently in the partner's structure, including those made before a client joined it; the other indicators cover activity at the time it happened.

Value in

  • "rebate"
  • "notionalValue"
  • "newClients"
  • "activeTraders"
  • "cpaReward"
  • "deposits"
  • "withdrawals"
startTime?string

Start of the reporting window (inclusive)

Formatdate-time
endTime?string

End of the reporting window (exclusive): operations at exactly this time are not counted; to include a whole day, pass the next day's 00:00

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner/performance-timeseries?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08&indicator=rebate"
{  "report": {    "series": [      {        "day": "string",        "value": "string"      }    ]  }}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}