Get trend analysis for user

get

https://api.pocketsmith.com/v2/users/{id}/trend_analysis

Get an income and/or expense budget analysis for the given date range and period across any number of categories and scenarios. Akin to the Trends page in PocketSmith.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The unique identifier of the user.

Query Params

period

string

enum

required

The period to analyse in, one of weeks, months or years. Also supported is event, although event period analysis is only possible when the budget events gathered align, so in this case where all categories are analysed together, it's highly unlikely that event period analysis will be possible.

Allowed:

interval

integer

required

The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly.

start_date

string

required

The date to start analysing the budget from. This will be bumped out to make full periods as necessary.

end_date

string

required

The date to stop analysing the budget from. This will be bumped out to make full periods as necessary.

categories

string

required

A comma-separated list of category IDs to analyse.

scenarios

string

required

A comma-separated list of scenario IDs to analyse. You're likely going to want to include all a user's scenarios here, unless you have reason to only analyse for a subset of scenarios. Regardless of what scenarios are analysed, all actuals (transactions) across all accounts will be included.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

403Not Allowed

404Not Found

422Validation Error