> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Report specification

> The specification of a report as defined by the API.

This is defined by a set of attributes as detailed below.

| Attribute | Description                                       |
| --------- | ------------------------------------------------- |
| `model`   | Name of the report model to be used               |
| `params`  | Parameters to be used for the chosen report model |

The specification is defined in the `spec` attribute of the request body
when a new report is created through the
[API endpoint to create a report](/reference/reports/new-report).

Below is an example of what a specification would look like:

```json theme={"system"}
{
  "model": "transactions",
  "params": {
    "fields": [ "id", "created_at"],
    "filters": {
      "status": ["capture_succeeded"]
    },
    "sort": [
      {
        "field": "created_at",
        "order": "desc"
      }
    ]
  }
}
```