Get information about a project session
GET {{baseUrl}}/api/sessions/projectId
Get information about a project session. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. Each time you call this endpoint, both the HTTP and Intelligence Server session timeouts are reset. This request returns information about the authenticated user, locale, timeout duration, maximum number of concurrent searches, and limit on instances kept in memory.
Body
PARAM
Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status OK
{
"locale": 1033,
"maxSearch": 3,
"workingSet": 10,
"timeout": 1800,
"id": "7FC05A65473CE2FD845CE6A1D3F13233",
"fullName": "MSTR User",
"initials": "MU"
} |
ENDPOINTS