THIS IS A REPRESENTATIVE QUERY FOR OUR FULLY FUNCTIONAL API. IT WILL NOT WORK UNTIL WE HAVE FULLY LAUNCHED THE API.
This sample query is to help understand complex query structure and the corresponding data returned through the API.
Retrieving Single Session data
query {
viewer {
organization {
scenarioSessions {
# INSERT everything below the `... on ScenarioSession` line vvquery {
node(id: "ljmnV58GM_c4AEHHiZy0qiSoP9HN3CnK7dbuPMNxx_M=") {
... on ScenarioSession {
startedAt
finishedAt
duration
idleDuration
numberOfStepsPossible
numberOfStepsViewed
percentOfStepsViewed
state
externalData # NOTE: this is where the data passed from the System of Record can be found
scenarioRelease {
author
publishedAt
scenario {
author {
id
name
}
description
name
origin_group {
name
}
published_at
}
type
version
}
events {
nodes {
attachments {
author
fileContentType
fileDownloadCount
fileFingerprint
fileName
fileSize
fileUpdatedAt
fileURL
fileURLExpiresAt
name
organization
owner
type }
deviceLocation {
altitude
device {
identifier
model
organization
os
}
isSindowsExe
latitude
longitude
platform
protocol
version
}
}
}
steps {
scenario_step {
name
orderIndex
scenarioSequence {
name
}
}
}
}
}
}
Retrieving all data for all Sessions
# To pull ALL scenario sessions for the org associated with currently authenticated user
query {
viewer {
organization {
scenarioSessions {
# INSERT everything below the `... on ScenarioSession` line vv# To pull the details for a scenario sessions with id = "ljmnV58GM_c4AEHHiZy0qiSoP9HN3CnK7dbuPMNxx_M="
query {
node(id: "ljmnV58GM_c4AEHHiZy0qiSoP9HN3CnK7dbuPMNxx_M=") {
... on ScenarioSession {
startedAt
finishedAt
duration
idleDuration
numberOfStepsPossible
numberOfStepsViewed
percentOfStepsViewed
state
externalData # NOTE: this is where the data passed from the System of Record can be found
scenarioRelease {
author
publishedAt
scenario {
author {
id
name
}
description
name
origin_group {
name
}
published_at
}
type
version
}
events {
nodes {
attachments {
author
fileContentType
fileDownloadCount
fileFingerprint
fileName
fileSize
fileUpdatedAt
fileURL
fileURLExpiresAt
name
organization
owner
type }
deviceLocation {
altitude
device {
identifier
model
organization
os
}
isSindowsExe
latitude
longitude
platform
protocol
version
}
}
}
steps {
scenario_step {
name
orderIndex
scenarioSequence {
name
}
}
}
}
}
}# Example response!
{
"data": {
"startedAt": "some value"
"finishedAt": "some value"
"duration": "some value"
"idleDuration": "some value"
"numberOfStepsPossible": "some value"
"numberOfStepsViewed": "some value"
"percentOfStepsViewed": "some value"
"state": "some value"
"externalData": {
# NOTE: this is where the data passed from the System of Record can be "found": "some value"
}
"scenarioRelease": {
"author": "some value"
"publishedAt": "some value"
"scenario": {
"author": {
"id": "some value"
"name": "some value"
}
"description": "some value"
"name": "some value"
"origin_group": {
"name": "some value"
}
"published_at": "some value"
}
"type": "some value"
"version": "some value"
}
"events": {
"nodes": {
"attachments": {
"author": "some value"
"fileContentType": "some value"
"fileDownloadCount": "some value"
"fileFingerprint": "some value"
"fileName": "some value"
"fileSize": "some value"
"fileUpdatedAt": "some value"
"fileURL": "some value"
"fileURLExpiresAt": "some value"
"name": "some value"
"organization": "some value"
"owner": "some value"
"type": "some value"
}
"deviceLocation": {
"altitude": "some value"
"device": {
"identifier": "some value"
"model": "some value"
"organization": "some value"
"os": "some value"
}
"isSindowsExe": "some value"
"latitude": "some value"
"longitude": "some value"
"platform": "some value"
"protocol": "some value"
"version": "some value"
}
}
}
"steps": {
scenario_step "{": "some value"
"name": "some value"
"orderIndex": "some value"
scenarioSequence "{": "some value"
"name": "some value"
}
}
}
}
}
Add Comment