Support
/
5 minute read
February 22, 2021

User Counts

Hidden

Retrieve user count data, such as the number of users with open accounts or how many have suspended accounts, at a specified aggregation level. The data is derived from the transaction-related messages sent to and from the Marqeta platform.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, and pagination. For more information about response options, see Response Customization.

Retrieve user count data (JSON)

Action: GET
Endpoint: /views/usercounts/{time_agg}

Retrieve user data, aggregated over the specified time period. This endpoint returns a JSON object that contains an array of records matching your filter query.

URL path parameters
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, week, month

Sample response body

The following sample shows a representative response for a GET request to the /views/usercounts/day?program=my_program&fields=user_type,in_suspension_eop,in_suspension_ever_during,entry_createdate endpoint.

Copied

Is this helpful?

Yes
No

Retrieve user count data (file export)

Action: GET
Endpoint: /views/usercounts/{time_agg}/{export_type}

Retrieve user data, aggregated over the specified time period. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

URL path parameters
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, week, month

export_type

string
Required

File format in which to export the data.

Allowable Values:

csv

Query parameters
Fields Description

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body
Copied

Is this helpful?

Yes
No

Retrieve user count schema

Action: GET
Endpoint: /views/usercounts/{time_agg}/schema

Retrieve a JSON representation of the usercounts view schema for data aggregated over the specified time period. The schema object contains an array of objects that describe the available columns and the data type of each column.

URL path parameters
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, week, month

Sample response body

The following sample shows a representative response for a GET request to the /views/usercounts/day/schema?program=my_program endpoint. The schema can vary based on the data aggregation level and the data you are authorized to access (based on the credentials you provide in your request).

Copied

Is this helpful?

Yes
No

Feedback on this page?

If you feel we can do anything better, please let our team know.