Gets the engagement dimensions. | Analytics Balancer API documentation

Gets the engagement dimensions. Run in API Explorer

GET /api/EngagementDimensions

Retrieves engagement configuration data including names, currencies, and identifiers. Sample value of Engagement Dimension

"Engagement_Key": 4316, "EngagementName": "John Doe Engagement", "EngagementCurrencyCode": "USD", "EngagementCurrencyName": "Dollar" "EngagementGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ShortGuid": "wH38Y1Tc"

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;odata.metadata=minimal;odata.streaming=true

application/json;odata.metadata=minimal;odata.streaming=true application/json;odata.metadata=minimal;odata.streaming=false application/json;odata.metadata=minimal application/json;odata.metadata=full;odata.streaming=true application/json;odata.metadata=full;odata.streaming=false application/json;odata.metadata=full application/json;odata.metadata=none;odata.streaming=true application/json;odata.metadata=none;odata.streaming=false application/json;odata.metadata=none application/json;odata.streaming=true application/json;odata.streaming=false application/json application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true application/json;odata.metadata=minimal;IEEE754Compatible=false application/json;odata.metadata=minimal;IEEE754Compatible=true application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true application/json;odata.metadata=full;IEEE754Compatible=false application/json;odata.metadata=full;IEEE754Compatible=true application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false application/json;odata.metadata=none;IEEE754Compatible=false application/json;odata.metadata=none;IEEE754Compatible=true application/json;odata.streaming=true;IEEE754Compatible=false application/json;odata.streaming=true;IEEE754Compatible=true application/json;odata.streaming=false;IEEE754Compatible=false application/json;odata.streaming=false;IEEE754Compatible=true application/json;IEEE754Compatible=false application/json;IEEE754Compatible=true

OK
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
Hide response attributes Show response attributes object
- engagement_Key integer(int32) Required
- engagementName string | null
- engagementCurrencyCode string | null
- engagementCurrencyName string | null
- engagementGuid string(uuid) Required
- shortGuid string | null
400 application/json

Bad Request
404 application/json

Not Found
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)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagement_Key": 42,
    "engagementName": "string",
    "engagementCurrencyCode": "string",
    "engagementCurrencyName": "string",
    "engagementGuid": "string",
    "shortGuid": "string"
  }
]