---
title: "Get engagement errors summary"
method: GET
path: "/v1/admin/monitoring/engagement_errors"
tags: ["Admin"]
---

# Get engagement errors summary

`GET /v1/admin/monitoring/engagement_errors`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/admin/monitoring/engagement_errors`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/admin/monitoring/engagement_errors/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves engagement error summary. Will return one row for each engagement that has errors in the given date range.  Supports filtering and paging.
### Filtering
The date range must be less than or equal to 180 days
Dates are specified as epoch milliseconds, GMT
Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/admin/monitoring/engagement_errors?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&propertyKey=AP-XXXXXXXXXXX-2 | Fetches first page of results |
| GET /v1/admin/monitoring/engagement_errors?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&propertyKey=AP-XXXXXXXXXXX-2&pageNumber=1&scrollId=abcxyz | Fetches second page of results |

## Query parameters

- `dateRangeEnd` integer
- `dateRangeStart` integer
- `pageNumber` integer
- `pageSize` integer
- `propertyKey` string
- `scrollId` string

## Response `200`

Success

- EngagementErrorSummaryPage
  - `engagementErrorSummaries` EngagementErrorSummary[]: Array of engagement error summaries
    - `engagementId` string
    - `engagementName` string
    - `propertyKey` string: PX Product Tag Key
    - `engagementType` 'EMAIL' | 'IN_APP_DIALOG' | 'IN_APP_CAROUSEL' | 'IN_APP_GUIDE' | 'IN_APP_NOTIFICATION' | 'OUT_BOUND_EMAIL' | 'IN_APP_NPS_SURVEY' | 'IN_APP_CES_SURVEY' | 'IN_APP_RATING_SURVEY' | 'IN_APP_BOOLEAN_SURVEY' | 'IN_APP_MULTIPLE_QUESTION_SURVEY'
    - `firstOccurrenceDate` integer: Timestamp of first error, in epoch milliseconds
    - `lastOccurrenceDate` integer: Timestamp of last error, in epoch milliseconds
    - `views` integer: Number of views of engagement
    - `ratio` number, double: Ratio of errors to views
    - `errorCount` integer: Number of errors
  - `totalHits` integer: Total number of records matching filters
  - `scrollId` string: If passed on subsequent requests as the scrollId parameter, will fetch the next page

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)