POST
/
reports
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Failed Authorizations 042022",
  "spec": {
    "model": "detailed_settlement",
    "params": {
      "filters": {
        "ingested_at": {
          "start": "day_start",
          "end": "day_end"
        }
      }
    }
  }
}'
{
  "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.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A request to create a report.

Response

201
application/json

Returns the report that was added.

A report record. A report record summary.