# Grid reports API by Observepoint

This section documents the API endpoints for using the ObservePoint Grid API, which provides access to ObservePoint data in row/column format. [Learn more about the Grid API](../sections/grid-api-intro.md)


## Servers

ObservePoint Production API
```
https://api.observepoint.com
```

## Security

### API_Key

Use the `Authorization` header in your requests with ObservePoint API key as header value.

Example: `Authorization: abc123...def456`


Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[Grid reports API by Observepoint](https://api-docs.observepoint.com/_spec/openapi/GRID-API.openapi.yaml)

## Other

### Get Grid Data

 - [POST /v3/reports/grid/{gridEntityType}](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/getgriddata.md): POST /v3/reports/grid/{gridEntityType}

This is the main endpoint for the Grid API. It lets you request data in row/column format for the
entities that ObservePoint has collected about your website


### Get Grid Schema

 - [GET /v3/reports/grid/{gridEntityType}/schema](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/getgridschema.md): GET /v3/reports/grid/{gridEntityType}/schema

Returns the list of columns that area available for the specified entity type, along with each column's ID, type, supported filter operators, and supported aggreate functions

### Create Saved Report

 - [POST /v3/reports/grid/saved](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/createsavedreport.md): A saved report contains information about the report, such as its name and permissions, and also the Grid API query definition that is applied when users view the report. The query definition uses the same JSON format as a Grid API request

### List Saved Reports

 - [GET /v3/reports/grid/saved](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/getsavedreportslist.md): GET /v3/reports/grid/saved

### Get Saved Report

 - [GET /v3/reports/grid/saved/{id}](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/getsavedreportbyid.md): GET /v3/reports/grid/saved/{id}

### Update Saved Report

 - [PUT /v3/reports/grid/saved/{id}](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/updatesavedreport.md): PUT /v3/reports/grid/saved/{id}

### Delete Saved Report

 - [DELETE /v3/reports/grid/saved/{id}](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/deletesavedreport.md): DELETE /v3/reports/grid/saved/{id}

### Favorite Saved Report

 - [POST /v3/reports/grid/saved/{id}/favorites](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/addsavedreporttofavorites.md): POST /v3/reports/grid/saved/{id}/favorites

Mark a saved report as a "favorite" for the user to whom the API key belongs

### Unfavorite Saved Report

 - [DELETE /v3/reports/grid/saved/{id}/favorites](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/removesavedreportfromfavorites.md): DELETE /v3/reports/grid/saved/{id}/favorites

Mark a saved report as not a favorite for the user to whom the API key belongs

### Start a grid data export

 - [POST /v3/reports/grid/{gridEntityType}/exports](https://api-docs.observepoint.com/openapi/grid-api.openapi/other/initiategriddataexport.md): POST /v3/reports/grid/{gridEntityType}/exports

Use this endpoint to start an export for a Grid request. After calling this endpoint, use the  endpoint to poll the status of
the export until it's finished. Then, you can download the results with the URL given by the  endpoint.

Learn how to use the Grid export API