DotsDocs
Users

Get User Payout Volume

Total payout volume received by a user over a timeframe.

GET
/v2/users/{user_id}/metrics/payouts

Total payout volume received by a user over a timeframe.

Authorization

api_key
headerAuthorizationBasic <token>

Path Parameters

user_id*string

Id of the user to report on

Formatuuid

Query Parameters

timeframe?string

Window to report over.

Default"all_time"
Value in"1d""3d""1w""1m""3m""1y""all_time"

Response Body

OK

application/json
  1. response
user_id?string
Formatuuid
timeframe?string
payouts_volume?number

Total volume received, in cents.

currency?string
Example Request
curl -X GET 'https://api.dots.dev/api/v2/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics/payouts'
Example Response
{  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "timeframe": "string",  "payouts_volume": 0,  "currency": "usd"}