API Reference

Get DataOne Income Report

get
https://api-sandbox.data.one/v1/reports/data-one-income-v1

This report provides a series of metrics to understand the income for the user. All metrics are available over 90, 180 and 365 day lookback windows from the current date. This report is generated using categorisation version 42.0.0.

Note: This is a pre-built report that uses the GET /reports endpoint with the reportId specified explicitly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required

The User ID.

accountId
array of uuids

Optional Account IDs. Can specify one or more values in order to aggregate over specific accounts. Leave out in order to aggregate over all user accounts.

accountId
Responses

400

Account IDs do not conform to UUID format.

401

API key authentication unsuccessful.

403

Access if forbidden if categorisation is disabled.

404

Report ID does not exist for partner.

Updated about 23 hours 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 about 23 hours ago