Gr4vy

Gr4vy Reports API

In Gr4vy, a report represents the configuration details to extract or dump a set of data into a downloadable CSV file. The data extracted by a report is configured via the reports API where you can specify: * Which fields should be in the dataset. * How the dataset should be sorted. * How the dataset should be filtered. Once a report is created, it may be executed on a one-off or recurring basis. One-off reports are executed only once shortly after the report is created, while recurring reports are executed periodically based on its configured frequency, e.g. weekly or monthly. During a report execution, the data is extracted and loaded into a CSV file according to the report's configuration. The resulting file may then be downloaded. The reports API can be used to: * Create and configure new reports. * List all reports. * View the configuration details of a report. * List a report's executions. * Reconfigure an existing report. * Generate a temporary URL to download the result of a report execution in CSV format.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 8

GET /report-executions List all report executions #
GET /report-executions/{report_execution_id} Get report execution #
POST /reports New report #
GET /reports List reports #
GET /reports/{report_id} Get report #
PUT /reports/{report_id} Update report #
GET /reports/{report_id}/executions List executions for report #
POST /reports/{report_id}/executions/{report_execution_id}/url Generate report download URL #

Documentation

📖
Documentation
https://docs.gr4vy.com/guides/get-started
📖
APIReference
https://docs.gr4vy.com/reference
📖
GettingStarted
https://docs.gr4vy.com/guides/get-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/authentication/gr4vy-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/rate-limits/gr4vy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/openapi/gr4vy-reports-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/scopes/gr4vy-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/errors/gr4vy-problem-types.yml
🔗
DeclineCodes
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/errors/gr4vy-decline-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/conventions/gr4vy-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/conventions/gr4vy-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/data-model/gr4vy-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/sandbox/gr4vy-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/asyncapi/gr4vy-webhooks.yml
🔗
Postman
https://github.com/gr4vy/gr4vy-postman

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gr4vy:gr4vy-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gr4vy-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gr4vy Reports API
  version: '1.0'
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: gr4vy-docs-v1-openapi.json, gr4vy-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sandbox.{id}.gr4vy.app
  x-speakeasy-server-id: sandbox
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
- url: https://api.{id}.gr4vy.app
  x-speakeasy-server-id: production
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
tags:


# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gr4vy/refs/heads/main/openapi/gr4vy-reports-api-openapi.yml