QueryResponse

Response wrapper for paginated query results.

Declaration

object QueryResponse

Properties

Name	Type	Description
`result`	[`QueryResponse.Result`]	The matching entity records for this query. Read-only.
`pagination`	`QueryPaginationResult`	Offset metadata for the result set. See QueryPaginationResult. Read-only.
`error`	`Error`	Error details if the request failed. Absent on success. See Error. Read-only.

Discussion

The QueryResponse object is the generic paginated response envelope returned by query endpoints.

This wrapper is the base type for all query responses. Specific entity query responses extend this pattern with a typed result array.

Example

{
  "result": [
    {
      "id": "123456789",
      "name": "AwayFinder Campaign"
    }
  ],
  "pagination": {
    "totalCount": 1,
    "offset": 0,
    "pageSize": 20
  }
}

Topics

Dictionaries

QueryResponse.Result