---
title: "Get engagement error details"
method: GET
path: "/v1/admin/monitoring/engagement_error_details/{engagementId}"
tags: ["Admin"]
---

# Get engagement error details

`GET /v1/admin/monitoring/engagement_error_details/{engagementId}`

## Request

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

Retrieves engagement error details. Will return one row for each engagement error.
Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/admin/monitoring/engagement_error_details/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&groupByBrowser=true | Error details grouped by browser|
| GET /v1/admin/monitoring/engagement_error_details/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&groupByBrowser=false | Error details grouped by type|

## Path parameters

- `engagementId` string, required

## Query parameters

- `dateRangeEnd` integer
- `dateRangeStart` integer
- `groupByBrowser` boolean

## Response `200`

Success

- EngagementErrorDetailsPage
  - `engagementErrorDetails` EngagementErrorDetails[]: Array of engagement error details
    - `engagementId` string
    - `stepName` string
    - `stepNumber` integer
    - `errorCount` integer: Number of errors
    - `errorType` string: Error type
    - `value` string: Error details
    - `browser` string: Type of browser

## 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)