DOCS

New!

/

5 minute read

August 1, 2019

Loads

Use this view endpoint to retrieve funding load transaction data at a specified aggregation level. For example, if you choose an aggregation level of detail, each row represents a single funding load transaction. 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, pagination, and currency conversion. For more information about response options, see Response Customization.

Retrieve load data (JSON)

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

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

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: detail, day, week, month

Sample response body

The following sample shows a representative response for a GET request to the views/loads/detail?program=my_program&amount=>6000&fields=acting_user_token,transaction_amount,post_date endpoint.

{
    "total": 3,
    "is_more": false,
    "count": 3,
    "info": {},
    "start_date": "2018-02-08T00:00:00+0000",
    "end_date": "2018-02-09T00:00:00+0000",
    "last_run_time": "2018-02-09T17:03:41Z",
    "schema": [
        {
            "field": "acting_user_token",
            "type": "character varying(128)",
            "display": "Acting User Token",
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        },
        {
            "field": "transaction_amount",
            "type": "numeric(14,2)",
            "display": "Transaction Amount",
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        },
        {
            "field": "post_date",
            "type": "date",
            "display": "Post Date",
            "units": null,
            "hasTotal": false,
            "date_format": "YYYY-MM-DD HH:mm:ss",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "acting_user_token": "BJT6WTBMQQAZ7EIC",
            "transaction_amount": 9363.92,
            "post_date": "2018-02-09T00:00:00.000Z"
        },
        {
            "acting_user_token": "WNYRX8Z8BLVYL7RE",
            "transaction_amount": 8506.53,
            "post_date": "2018-02-09T00:00:00.000Z"
        },
        {
            "acting_user_token": "A9ZZ6G9OT94XJQC3",
            "transaction_amount": 6748.36,
            "post_date": "2018-02-08T00:00:00.000Z"
        }
    ]
}

Is this helpful?

Retrieve load data (file export)

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

Retrieve funding loads transaction 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.

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: detail, 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 load schema

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

Retrieve a JSON representation of the funding loads 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.

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: detail, day, week, month

Sample response body

The following sample shows a representative response for a GET request to the /views/loads/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).

[
    {
        "field": "acting_id",
        "type": "integer",
        "display": "Acting Id",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "acting_user_token",
        "type": "character varying(128)",
        "display": "Acting User Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "post_date",
        "type": "date",
        "display": "Post Date",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "is_filter_only": false
    },
    {
        "field": "transaction_token",
        "type": "integer",
        "display": "Transaction Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "order_token",
        "type": "character varying(80)",
        "display": "Order Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_status",
        "type": "character varying(128)",
        "display": "Transaction Status",
        "enum_values": [],
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_amount",
        "type": "numeric(14,2)",
        "display": "Transaction Amount",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "last_modified_time",
        "type": "timestamp without time zone",
        "display": "Last Modified Time",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "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.