DOCS

New!

/

5 minute read

October 5, 2019

User Counts

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.

{
    "total": 30,
    "is_more": false,
    "count": 30,
    "info": {},
    "start_date": "2019-02-01T00:00:00+0000",
    "end_date": "2019-02-14T00:00:00+0000",
    "last_run_time": "2019-02-06T00:02:00Z",
    "schema": [
        {
            "field": "user_type",
            "type": "character varying(128)",
            "description": "Designates the type of user record as being child, parent or business.",
            "display": "User Type",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "in_suspension_eop",
            "type": "bigint",
            "description": null,
            "display": "In Suspension Eop",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "in_suspension_ever_during",
            "type": "bigint",
            "description": null,
            "display": "In Suspension Ever During",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "entry_createdate",
            "type": "timestamp without time zone",
            "description": "The date and time when a record has been read into the database following a replication cycle.",
            "display": "Entry Createdate",
            "units": null,
            "has_total": false,
            "date_format": "YYYY-MM-DD",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "user_type": "USER",
            "in_suspension_eop": 2,
            "in_suspension_ever_during": 2,
            "entry_createdate": "2019-02-06T00:00:00.000Z"
        },
        {
            "user_type": "USER",
            "in_suspension_eop": 2,
            "in_suspension_ever_during": 2,
            "entry_createdate": "2019-02-06T00:00:00.000Z"
        },
        ...
        {
            "user_type": "USER",
            "in_suspension_eop": 2,
            "in_suspension_ever_during": 2,
            "entry_createdate": "2019-02-06T00:00:00.000Z"
        }
    ]
}

Is this helpful?

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

{
    "token":"111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

Is this helpful?

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).

[
    {
        "field": "program",
        "type": "character varying(128)",
        "description": "The name of the card program.",
        "display": "Program",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "period_start_date",
        "type": "date",
        "description": null,
        "display": "Period Start Date",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "user_type",
        "type": "character varying(128)",
        "description": "Designates the type of user record as being child, parent or business.",
        "display": "User Type",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "open_eop",
        "type": "bigint",
        "description": null,
        "display": "Open Eop",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "limited_eop",
        "type": "bigint",
        "description": null,
        "display": "Limited Eop",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "in_suspension_eop",
        "type": "bigint",
        "description": null,
        "display": "In Suspension Eop",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "open_ever_during",
        "type": "bigint",
        "description": null,
        "display": "Open Ever During",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "in_suspension_ever_during",
        "type": "bigint",
        "description": null,
        "display": "In Suspension Ever During",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "opened_during_period",
        "type": "bigint",
        "description": null,
        "display": "Opened During Period",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "activated_during_period",
        "type": "bigint",
        "description": null,
        "display": "Activated During Period",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "suspended_during_period",
        "type": "bigint",
        "description": null,
        "display": "Suspended During Period",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "terminated_during_period",
        "type": "bigint",
        "description": null,
        "display": "Terminated During Period",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "swiped_during_period",
        "type": "bigint",
        "description": null,
        "display": "Swiped During Period",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "entry_createdate",
        "type": "timestamp without time zone",
        "description": "The date and time when a record has been read into the database following a replication cycle.",
        "display": "Entry Createdate",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "last_modified_time",
        "type": "timestamp without time zone",
        "description": "The date when the record was most recently updated.",
        "display": "Last Modified Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "etl_batch_id",
        "type": "bigint",
        "description": null,
        "display": "Etl Batch Id",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]

Is this helpful?

Have any feedback on this page?

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

We strive for the best possible developer experience.