Skip to main content
Use this view endpoint to retrieve card state and history data aggregated by card. The data is derived from card information in 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 card data (JSON)

Action: GET
Endpoint: /views/cards/detail Retrieve card state and history data aggregated by card. This endpoint returns a JSON object that contains an array of records matching your filter query.

​
Sample response body

The following sample shows a representative response for a GET request to the /views/cards/detail?program=my_program&fields=card_created_date,card_activation_date,card_state,card_type&card_created_date=2022-09-01..2022-09-30 endpoint.
JSON
{
     "total": 47067,
     "is_more": true,
     "count": 10000,
     "info": {},
     "start_date": "2022-09-01T15:13:53+0000",
     "end_date": "2022-09-30T23:58:16+0000",
     "last_run_time": "2023-03-09T10:03:22Z",
    "schema": [
        {
            "field": "card_created_date",
            "type": "date",
            "display": "Card Created Date",
            "units": null,
            "hasTotal": false,
            "date_format": "YYYY-MM-DD HH:mm:ss",
            "is_filter_only": false
        },
        {
            "field": "card_activation_date",
            "type": "date",
            "display": "Card Activation Date",
            "units": null,
            "hasTotal": false,
            "date_format": "YYYY-MM-DD HH:mm:ss",
            "is_filter_only": false
        },
        {
            "field": "card_state",
            "type": "character varying(128)",
            "display": "Card State",
            "enum_values": [],
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        },
        {
            "field": "card_type",
            "type": "character varying(128)",
            "display": "Card Type",
            "enum_values": [],
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        }
    ],
     "records": [
         {
             "card_created_date": "2022-09-30T20:32:19.000Z",
             "card_activation_date": "2022-09-30T00:00:00.000Z",
             "card_state": "ACTIVE",
             "card_type": "Virtual",
         },
         …
     ]
 }

​
Retrieve card data (file export)

Action: GET
Endpoint: /views/cards/detail/{export_type} Retrieve card state and history data aggregated by card. 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

FieldsDescription
export_type

string
Required		File format in which to export the data.

Allowable Values:

csv

​
Query parameters

FieldsDescription
compress

string
optional		Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

​
Sample response body

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

​
Retrieve card schema

Action: GET
Endpoint: /views/cards/detail/schema Retrieve a JSON representation of the card view schema for data aggregated by card. The schema object contains an array of objects that describe the available columns and the data type of each column.

​
Sample response body

The following sample shows a representative response for a GET request to the /views/cards/detail/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).
JSON
[
    {
        "field": "user_id",
        "type": "integer",
        "display": "User Id",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "user_token",
        "type": "character varying(128)",
        "display": "User Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "card_token",
        "type": "character varying(128)",
        "display": "Card Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "card_product_name",
        "type": "character varying(128)",
        "display": "Card Product Name",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "card_created_date",
        "type": "date",
        "display": "Card Created Date",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "is_filter_only": false
    },
    {
        "field": "card_activation_date",
        "type": "date",
        "display": "Card Activation Date",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "is_filter_only": false
    },
    {
        "field": "card_state",
        "type": "character varying(128)",
        "display": "Card State",
        "enum_values": [
            "Active",
            "Suspended",
            "Terminated",
            "Unactivated"
        ],
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "card_type",
        "type": "character varying(128)",
        "display": "Card Type",
        "enum_values": [
            "Physical Icc",
            "Physical Msr",
            "Virtual Pan"
        ],
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "issued_cards",
        "type": "integer",
        "display": "Issued Cards",
        "units": null,
        "hasTotal": true,
        "is_filter_only": false
    },
    {
        "field": "unactivated_cards",
        "type": "integer",
        "display": "Unactivated Cards",
        "units": null,
        "hasTotal": true,
        "is_filter_only": false
    },
    {
        "field": "active_cards",
        "type": "integer",
        "display": "Active Cards",
        "units": null,
        "hasTotal": true,
        "is_filter_only": false
    },
    {
        "field": "suspended_cards",
        "type": "integer",
        "display": "Suspended Cards",
        "units": null,
        "hasTotal": true,
        "is_filter_only": false
    },
    {
        "field": "terminated_cards",
        "type": "integer",
        "display": "Terminated Cards",
        "units": null,
        "hasTotal": true,
        "is_filter_only": false
    }
]

Related topics

Introduction to the DiVA APIErrors DiVA APIExploring the DiVA APIAuthentication with the DiVA APIReporting Overview