Get engagement dimension. | Analytics Task Manager API documentation

Get engagement dimension. Run in API Explorer

GET /api/EngagementDimension

This request should be used to retrieve the engagement dimension data for specified engagement(s). This includes the engagement name and an engagement key that is used to form relationships to other dimensions.

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

Success
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
Hide response attributes Show response attributes object
- engagementKey string(uuid)
- engagementName string | null
- shortGuid string | null
400

Bad Request
404

Not Found
500

Server Error

GET /api/EngagementDimension

curl \
 --request GET 'https://analyticsapi.adratest.com/taskmanager/api/EngagementDimension' \
 --user "username:password"

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "ShortGuid": "1SqawAw2",
    "EngagementKey": "96635f8e-5ef4-431c-8d06-257e41243cf2",
    "EngagementName": "Analytics Test Engagement"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]

Response examples (200)

[
  {
    "engagementKey": "string",
    "engagementName": "string",
    "shortGuid": "string"
  }
]