# Models

## The Report object

```json
{"openapi":"3.1.0","info":{"title":"Partner Reports API","version":"15"},"components":{"schemas":{"Report":{"type":"object","properties":{"Name":{"type":"string","description":"Display name of the report."},"Id":{"type":"string","description":"The report handle used in the path of all other Report endpoints."},"Category":{"type":"string","enum":["Admin","Beta","Compliance","Cross-Program","Custom","Finance","Insights","Listing","Operations","Performance"],"description":"Category that groups related reports in the impact.com UI. May be empty for some reports."},"Description":{"type":"string","description":"A short description of what the report contains."},"ApiAccessible":{"type":"boolean","description":"When `true`, this report can be run via the API at `ApiRunUri` and exported via `DeferredApiRunUri`. When `false`, the report is UI-only and `RunUri` contains the impact.com web app link."},"ApiRunUri":{"type":"string","description":"API resource path to run this report synchronously. Present only when `ApiAccessible` is `true`."},"DeferredApiRunUri":{"type":"string","description":"API resource path to export this report asynchronously. Present only when `ApiAccessible` is `true`."},"MetaDataUri":{"type":"string","description":"API resource path to retrieve this report's metadata. Present only when `ApiAccessible` is `true`."},"RunUri":{"type":"string","description":"Link to view the report in the impact.com web app. Present only when `ApiAccessible` is `false`."}}}}}}
```

## The ReportMetadata object

```json
{"openapi":"3.1.0","info":{"title":"Partner Reports API","version":"15"},"components":{"schemas":{"ReportMetadata":{"type":"object","properties":{"Name":{"type":"string","description":"Display name of the report."},"Id":{"type":"string","description":"The report handle."},"Description":{"type":"string","description":"A short description of what the report contains."},"Filters":{"type":"array","description":"The filters this report accepts as query parameters when run.","items":{"$ref":"#/components/schemas/ReportFilter"}},"Attributes":{"type":"array","description":"The columns this report returns. Each row in a Run Report response contains one key per attribute.","items":{"$ref":"#/components/schemas/ReportAttribute"}},"RunUri":{"type":"string","description":"API resource path to run this report."},"Uri":{"type":"string","description":"Unique reference to this report's metadata in the impact.com API."}}},"ReportFilter":{"type":"object","properties":{"Name":{"type":"string","description":"The filter's name. Use this as the query parameter when running the report."},"DataType":{"type":"string","enum":["Boolean","Date (yyyy-MM-dd'T'HH:mm:ssZZ)","Decimal","Integer","String"],"description":"Data type the filter accepts."},"Format":{"type":"string","description":"Additional format hint for the filter, if any."}}},"ReportAttribute":{"type":"object","properties":{"Name":{"type":"string","description":"The column name as it appears in each record returned by Run Report."},"DataType":{"type":"string","description":"Data type of values in this column."},"Description":{"type":"string","description":"A short description of what this column represents."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/partner-v15/reference/reports/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
