Skip to content
Grid Reporting API/
/
Start a grid data export

Start a grid data export

Request

POST /v3/reports/grid/{gridEntityType}/exports

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

Learn how to use the Grid export API

Security
API_Key
Path
gridEntityTypestringrequired

grid entity type

Enum:"web-audit-runs""web-journey-runs""pages""cookies""tags""tag-variables""links""accessibility-issues""network-requests""browser-logs"
Bodyapplication/jsonrequired
sizeinteger, [ 10 .. 10000 ]

how many rows to include in the paginated response

pageinteger, >= 0

paginated response page number, starts with 0

filtersobject
columnsArray of any, [ 1 .. 1000 ] items
sortByArray of objects, [ 0 .. 1000 ] items

Sorts the result by the specified columns, in the same order as in the columns array.

totalsArray of objects, [ 0 .. 1000 ] items

Dynamic Aggregation Row totals for columns. As for now, only one aggregation is supported for each column (same columnIndex) in the columns array.

itemNamestring
customExportFileNamestring

Override for export file name (without file extension)

fileFormatstring

Format of the exported file

Default:"xlsx"
Enum:"csv""tsv""xlsx"
POST
/v3/reports/grid/{gridEntityType}/exports
curl -i -X POST \
  'https://api.observepoint.com/v3/reports/grid/{gridEntityType}/exports' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "size": 10,
    "page": 0,
    "filters": {
      "conditions": [
        {
          "negated": false,
          "operator": "string_contains",
          "filteredColumn": {
            "groupBy": false,
            "columnId": "string",
            "format": "string"
          },
          "fieldName": "id",
          "arg": "string",
          "wildcardStart": true,
          "wildcardEnd": true
        }
      ],
      "conditionMatchMode": "all"
    },
    "columns": [
      {
        "groupBy": false,
        "columnId": "string",
        "format": "string"
      }
    ],
    "sortBy": [
      {
        "columnIndex": 0,
        "sortDesc": false
      }
    ],
    "totals": [
      {
        "columnIndex": 0,
        "aggregateFunction": "avg"
      }
    ],
    "itemName": "string",
    "customExportFileName": "string",
    "fileFormat": "csv"
  }'

Responses

Grid export ID

Bodyapplication/json
exportIdinteger, (int64)required

Unique ID of a grid export

Response
{
  "exportId": 0
}