Skip to main content
GET
/
reports
List reports
using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/reports");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);
{
  "items": [
    {
      "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",
      "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"
        }
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}
This endpoint requires the reports.read scope.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string<>

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Example:

"ZXhhbXBsZTE"

​
limit
integer<int32>
default:20

Defines the maximum number of items to return for this request.

Required range: 1 <= x <= 100
Example:

1

​
name
string

Filters for reports that have a matching name value. This filter is case-insensitive.

Ensure that when necessary, the value you pass for this filter is URL encoded.

Example:

"Failed+Authorizations+042022"

​
schedule
enum<string>[]

Filters for reports that have matching schedule values.

Available options:
daily,
monthly,
once,
weekly
Example:
["once", "monthly"]
​
schedule_enabled
boolean

Filters for reports that have a matching schedule_enabled value.

Example:

true

Response

Returns a list of reports.

A list of reports.

​
items
Report · object[]

A list of reports.

​
limit
integer<int32>
default:20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 <= x <= 100
Example:

1

​
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

​
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

null