Reports
Get report
Payments
- Transactions
- Buyers
- Checkout Sessions
- Payment links
- Payment options
- Payouts
- Refunds
- Sessions
- Settlement records
Instruments
- Card schemes
- Card details
- Digital wallets
- Gift cards
- Payment methods
- Payment method definitions
Vault
- Account updater
- Network tokens
- Payment service tokens
- Vault Forward
- Vault Forward endpoints
- Vault Forward authentication
Connections
- All services
- Payment services
- Digital wallets
- Anti-fraud services
Other
- Flow
- Reports
- Report executions
- Webhook subscriptions
Reports
Get report
Retrieves the details of a single report.
GET
/
reports
/
{report_id}
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/reports/{report_id} \
--header 'Authorization: Bearer <token>'
{
"type": "report",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"name": "Failed Authorizations 042022",
"creator_id": "bd5d40d1-913b-419c-bd62-84efc46e0026",
"creator_display_name": "John Doe",
"creator_type": "user",
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"next_execution_at": "2023-01-01T00:00:00.000+00:00",
"description": "Transactions that failed to authorize in April 2022",
"schedule": "monthly",
"schedule_enabled": true,
"schedule_timezone": "<string>",
"spec": {
"model": "detailed_settlement",
"params": {
"filters": {
"ingested_at": {
"start": "day_start",
"end": "day_end"
}
}
}
},
"latest_execution": {
"type": "report-execution",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"status": "succeeded",
"context": {
"reference_timestamp": "2013-07-16T19:23:00.000+00:00",
"reference_timezone": "Europe/London"
}
}
}
This endpoint requires the reports.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID for a report.
Example:
"8724fd24-5489-4a5d-90fd-0604df7d3b83"
Response
200
application/json
Returns a report.
A report record.
Was this page helpful?
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/reports/{report_id} \
--header 'Authorization: Bearer <token>'
{
"type": "report",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"name": "Failed Authorizations 042022",
"creator_id": "bd5d40d1-913b-419c-bd62-84efc46e0026",
"creator_display_name": "John Doe",
"creator_type": "user",
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"next_execution_at": "2023-01-01T00:00:00.000+00:00",
"description": "Transactions that failed to authorize in April 2022",
"schedule": "monthly",
"schedule_enabled": true,
"schedule_timezone": "<string>",
"spec": {
"model": "detailed_settlement",
"params": {
"filters": {
"ingested_at": {
"start": "day_start",
"end": "day_end"
}
}
}
},
"latest_execution": {
"type": "report-execution",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"status": "succeeded",
"context": {
"reference_timestamp": "2013-07-16T19:23:00.000+00:00",
"reference_timezone": "Europe/London"
}
}
}