GuidesAPI Reference
API Reference

Get trend analysis for user

get
https://api.pocketsmith.com/v2/users//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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier of the user.

Query Params
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:
integer
required

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

string
required

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

string
required

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

string
required

A comma-separated list of category IDs to analyse.

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

Updated 12 months ago

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

Updated 12 months ago