Gets the engagement dimensions. Run in API Explorer

GET /api/EngagementDimensions

Retrieves engagement configuration data including names, currencies, and identifiers.

Query parameters

  • engagement string

    Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1

Responses

  • 200 application/json
  • 404 application/json

    Not Found

  • 400 application/json

    Bad Request

  • 500 application/json

    Internal Server Error

GET /api/EngagementDimensions
curl \
 --request GET 'https://analyticsapi.adra.com/balancer/api/EngagementDimensions' \
 --user "username:password"
Response examples (200)
[
  {
    "ShortGuid": "wH38Y1Tc",
    "EngagementGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "EngagementName": "John Doe Engagement",
    "Engagement_Key": 4316,
    "EngagementCurrencyCode": "USD",
    "EngagementCurrencyName": "Dollar"
  }
]