/user//monthly
Description:
The /user/{userId}/monthly
endpoint allows users to retrieve monthly statistics like count and RoyaltyShare related to a specific user identified by their unique userId.
By default, returns the last 12 months of data. Use optional query parameters to filter specific date ranges.
Method:
GET
Path Parameter:
Parameter | Type | Description |
---|---|---|
userId | string | The unique identifier of the user. |
Query Parameters:
Parameter | Type | Required | Description |
---|---|---|---|
period | string | No | Period preset: all , last12months , ytd , or custom . If custom , requires startDate/endDate. |
startDate | string | No | Start date for filtering (YYYY-MM-DD format). Overrides period parameter. |
endDate | string | No | End date for filtering (YYYY-MM-DD format). Overrides period parameter. |
Parameter Priority:
Examples:
/user/{id}/monthly
- Returns last 12 months (default)/user/{id}/monthly?period=all
- Returns all historical data/user/{id}/monthly?period=ytd
- Returns year-to-date data/user/{id}/monthly?period=last12months
- Same as default/user/{id}/monthly?startDate=2024-01-01&endDate=2024-12-31
- Custom range (ignores period)/user/{id}/monthly?startDate=2024-06-01
- From June 2024 to todaySee Sample Response Below
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
User ID
Period preset for filtering monthly data
all
, last12months
, ytd
, custom
"ytd"
Start date for filtering monthly data (YYYY-MM-DD format)
"2024-01-01"
End date for filtering monthly data (YYYY-MM-DD format)
"2024-12-31"
success
The response is of type object
.