Get Grid Data

Request

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

Security

API_Key

Path

gridEntityTypestringrequired

The grid entity type for which you want to query data

Enum:"web-audit-runs""web-journey-runs""pages""cookies""tags""tag-variables""links""accessibility-issues""network-requests""browser-logs"

Bodyapplication/json

sizeinteger, [ 10 .. 10000 ]

how many rows to include in the paginated response

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.

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.

curl -i -X POST \
  'https://api.observepoint.com/v3/reports/grid/{gridEntityType}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "size": 10,
    "totals": [
      {
        "columnIndex": 0,
        "aggregateFunction": "avg"
      }
    ],
    "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
      }
    ]
  }'

Responses

Grid Data

Bodyapplication/json

metadataobjectrequired

Contains information about the response, such as pagination and returned columns/headers.

rowsArray of items, >= 0 itemsrequired

Response

{
  "metadata": {
    "pagination": { … },
    "headers": [ … ]
  },
  "rows": [
    [ … ]
  ]
}

Get Grid Data

Request

Path

Responses

Was this helpful?