Views
Use this endpoint to retrieve a list of the available view endpoints from the DiVA API. Each view endpoint provides access to a specific type of data on the Marqeta platform that is aggregated at a specific level. For example, a view can provide access to authorization transaction data aggregated by week. For more information about data aggregation levels, see Response Customization.
Retrieve views
Copy section link
Action: GET
Endpoint: /views
This endpoint returns an array of objects that describe the available views. Each object contains metadata about a view, such as the default filters and aggregation level, if available.
Response body
Copy section link
| Fields | Description |
|---|---|
default_date
string
|
Date field used in the default filter for API requests without a date range in the query filter. Allowable Values: Name of a date field in the view schema. |
default_filter
object
|
Object that describes the default filter for API requests without a date range in the query filter. Allowable Values: |
display
string
|
Summary field for the related report in the Marqeta Dashboard. Allowable Values: |
endpoint
string
|
Relative URL to the DiVA API endpoint for retrieving the view. Allowable Values: |
expansion
object
|
Object that describes the expandable fields for a schema. Expanding a field value returns a more detailed breakdown of data for that field. For example, you can pass the Null if no values are expandable. Allowable Values: |
fields_domain
string
|
List of all fields that are available in the view schema. Allowable Values: Comma-delimited list of fields in the view schema. |
filter_domain
string
|
List of fields that are not returned as data in the view but that you can use for filtering results (indicated by the Allowable Values: Comma-delimited list of fields in the view schema. |
report
string
|
Category of the related report in the Marqeta Dashboard. Allowable Values: |
schema
string
|
Relative URL to the DiVA API endpoint for retrieving the view schema. Allowable Values: |
type
string
|
Name of the related report in the Marqeta Dashboard. Allowable Values: |
The default_filter object (response)
Copy section link
| Fields | Description |
|---|---|
fields
string
|
View fields returned by default for API requests without a field filter. Allowable Values: Comma-delimited list of fields in the view schema. |
default_date_field_name
string
|
Date range filter applied for API requests without a date range in the query filter. The default date range includes results for a recent period of time based on when the query is run. Allowable Values: Date range following the query filter syntax. |
The expansion object (response)
Copy section link
| Fields | Description |
|---|---|
expand_argument_1 … expand_argument_N
string
|
Name of an argument to the
JSON Copied Allowable Values: Name-value pairs of an argument name and a comma-delimited list of additional field names. |