Partner

Get Performance Stats

GET
/partner/performance-stats

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 stats are requested

Formatuuid
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-stats?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "report": {    "aggregation": {      "rebate": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "notionalValue": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "newClients": {        "actualValue": 0,        "absoluteChange": 0      },      "activeTraders": {        "actualValue": 0,        "absoluteChange": 0      },      "cpaReward": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "deposits": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "string"      },      "withdrawals": {        "actualValue": "string",        "absoluteChange": "string",        "currency": "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"    }  ]}