gainsight-px-rest-api
GET /v1/admin/monitoring/engagement_error_details/{engagementId}

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

    Engagement id

Query parameters

  • dateRangeEnd integer(int64)

    Date range end (epoch milliseconds)

  • dateRangeStart integer(int64)

    Date range start (epoch milliseconds)

  • groupByBrowser boolean

    True to group by browser type, false to group by error

Responses

  • 200 */*

    Success

    Hide response attribute Show response attribute object
    • engagementErrorDetails array[object]

      Array of engagement error details

      Hide engagementErrorDetails attributes Show engagementErrorDetails attributes object

      Engagement Error Details

      • engagementId string
      • stepName string
      • stepNumber integer(int32)
      • errorCount integer(int64)

        Number of errors

      • errorType string

        Error type

      • value string

        Error details

      • browser string

        Type of browser
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/admin/monitoring/engagement_error_details/{engagementId} 
curl \
 --request GET 'https://api.aptrinsic.com/v1/admin/monitoring/engagement_error_details/{engagementId}'
Response examples (200) 
{
  "engagementErrorDetails": [
    {
      "engagementId": "string",
      "stepName": "string",
      "stepNumber": 42,
      "errorCount": 42,
      "errorType": "string",
      "value": "string",
      "browser": "string"
    }
  ]
}