Total spend amount by category

This API method retrieves the total spend amount by category for a given time period. It provides insights into how spending is distributed across different categories, along with the corresponding amount and percentage share of the total spend.

Query Parameters:

  • period (date-time): Specifies the time period for which the spending data should be retrieved.
  • isoId (int32): Optional parameter to filter spending data by ISO (Independent Sales Organization) ID.
  • agentId (int32): Optional parameter to filter spending data by agent ID.

Functionality:

  • Purpose: To obtain spending data categorized by type (e.g., groceries, utilities) for a specific period.
  • Response: Returns a list of spending categories, along with the total amount spent and the percentage of total spending for each category.
📘

Summary:

The GET /api/Widget/SpendsByCategory API is designed to deliver comprehensive data on how spending is distributed across different categories for a specified period. It is a valuable tool for businesses seeking detailed spending insights, allowing them to analyze customer behavior, track spending trends, and plan targeted marketing efforts based on spending preferences.

Query Params
date-time
int32
int32
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json