/

5 minute read

November 10, 2020

Platform Response

Retrieve platform response data, including JIT gateway transactions, average duration, and average gateway duration. 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 platform response data (JSON)

Action: GET
Endpoint: /views/platformresponse/month

Retrieve user data, aggregated over the most recent 30-day period. 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/platformresponse/month?program=my_program&fields=jit_gateway_trans,avg_duration,avg_gateway_duration endpoint.

{
    "total": 0,
    "is_more": false,
    "count": 0,
    "info": {},
    "start_date": null,
    "end_date": null,
    "last_run_time": "",
    "schema": [
        {
            "field": "jit_gateway_trans",
            "type": "integer",
            "description": null,
            "display": "Jit Gateway Trans",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "avg_duration",
            "type": "numeric(14,2)",
            "description": null,
            "display": "Avg Duration",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "avg_gateway_duration",
            "type": "numeric(14,2)",
            "description": null,
            "display": "Avg Gateway Duration",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "jit_gateway_trans": "784",
            "avg_duration": "548.00",
            "avg_gateway_durationn": "468.00",
        },
        {
            "jit_gateway_trans": "6100",
            "avg_duration": "529.00",
            "avg_gateway_durationn": "115.00",
        },

        ...

        {
            "jit_gateway_trans": "5892",
            "avg_duration": "249.00",
            "avg_gateway_durationn": "191.00",
        }
    ]
}

Is this helpful?

Retrieve platform response data (file export)

Action: GET
Endpoint: /views/platformresponse/month/{export_type}

Retrieve user data, aggregated over the most recent 30-day 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

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 platform response schema

Action: GET
Endpoint: /views/platformresponse/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/platformresponse/month/schema?program=my_program endpoint. The schema can vary based on 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": "bank",
        "type": "character varying(128)",
        "description": "The bank under which the program operates.",
        "display": "Bank",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "tran_month",
        "type": "date",
        "description": null,
        "display": "Tran Month",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "jit_gateway_trans",
        "type": "integer",
        "description": null,
        "display": "Jit Gateway Trans",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "avg_duration",
        "type": "numeric(14,2)",
        "description": null,
        "display": "Avg Duration",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "avg_gateway_duration",
        "type": "numeric(14,2)",
        "description": null,
        "display": "Avg Gateway Duration",
        "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.