Rally API Documentation
Rally's GraphQL API enables you to manage customer accounts, spaces, stories, and media.
Authentication
All API requests require authentication using OAuth 2.0 Bearer tokens. Include your access token in the Authorization header:
Authorization: Bearer YOUR_ACCESS_TOKEN
Additionally, include your organization ID in the X-ORG-ID header:
X-ORG-ID: YOUR_ORG_ID
Rate Limiting
The API is rate limited to 1000 requests per minute per IP address.
Endpoints
- Production:
https://api.rally.space/graphql
Support
For API support, contact the Rally development team.
API Endpoints
https://api.rally.space/graphql
Version
1.0.0
Queries
account
Example
Query
query account($id: UUID!) {
account(id: $id) {
accountMemoryEntries {
...AccountMemoryEntryFragment
}
avatarMedia {
...MediaFragment
}
avatarMediaId
createdAt
createdBy
id
isDeleted
name
nodeId
organizationId
ownedBy
owner {
...UserFragment
}
spaces {
...AccountSpaceFragment
}
updatedAt
website
}
}
Variables
{
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
Response
{
"data": {
"account": {
"accountMemoryEntries": [AccountMemoryEntry],
"avatarMedia": Media,
"avatarMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"name": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"ownedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"owner": User,
"spaces": [AccountSpace],
"updatedAt": Datetime,
"website": "xyz789"
}
}
}
accountSearch
Response
Returns [AccountSearchResult!]
Arguments
| Name | Description |
|---|---|
input - AccountSearchInput!
|
Example
Query
query accountSearch($input: AccountSearchInput!) {
accountSearch(input: $input) {
createdBy
id
name
organizationId
relevance
updatedAt
website
}
}
Variables
{"input": AccountSearchInput}
Response
{
"data": {
"accountSearch": [
{
"createdBy": "abc123",
"id": 4,
"name": "xyz789",
"organizationId": "xyz789",
"relevance": "abc123",
"updatedAt": "abc123",
"website": "abc123"
}
]
}
}
collectionSearch
Response
Returns [CollectionSearchResult!]
Arguments
| Name | Description |
|---|---|
input - CollectionSearchInput!
|
Example
Query
query collectionSearch($input: CollectionSearchInput!) {
collectionSearch(input: $input) {
createdBy
description
id
name
organizationId
presentation
relevance
updatedAt
}
}
Variables
{"input": CollectionSearchInput}
Response
{
"data": {
"collectionSearch": [
{
"createdBy": "abc123",
"description": "xyz789",
"id": "4",
"name": "abc123",
"organizationId": "abc123",
"presentation": "BOARD",
"relevance": 123.45,
"updatedAt": Datetime
}
]
}
}
getOrganizationSpaces
Response
Returns [Space!]!
Arguments
| Name | Description |
|---|---|
input - GetOrganizationSpacesInput
|
Example
Query
query getOrganizationSpaces($input: GetOrganizationSpacesInput) {
getOrganizationSpaces(input: $input) {
accentColor
accessPolicy
accounts {
...AccountSpaceFragment
}
actionPlan {
...ActionPlanFragment
}
audienceLogo
audienceLogoMedia {
...MediaFragment
}
audienceName
audienceThumbnail {
...MediaFragment
}
author {
...UserFragment
}
bannerImage
createdAt
createdBy
deletedAt
description
externalParticipants {
...SpaceExternalParticipantFragment
}
id
internalParticipants {
...SpaceInternalParticipantFragment
}
isTemplateEphemeral
metadata
name
nodeId
organization {
...OrganizationFragment
}
organizationId
passwordRequired
passwords {
...SpacePasswordFragment
}
pointOfContact {
...UserFragment
}
pointOfContactId
primaryColor
resources {
...SpaceResourceFragment
}
spaceActionPlanItemResponses {
...ActionPlanItemResponseFragment
}
spaceActivityEvents {
...SpaceActivityEventFragment
}
spaceBlocks {
...SpaceBlockFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
spaceParticipantMetrics {
...ReportSpaceParticipantMetricFragment
}
spaceParticipantSessionTotals {
...ReportSpaceParticipantSessionTotalFragment
}
spaceParticipants {
...SpaceParticipantFragment
}
spaceSessionDurations {
...ReportSpaceSessionDurationFragment
}
spaceSessionStatistics {
...ReportSpaceSessionStatisticFragment
}
template {
...SpaceTemplateFragment
}
templateId
thumbnailOverride
updatedAt
workflowState
}
}
Variables
{"input": GetOrganizationSpacesInput}
Response
{
"data": {
"getOrganizationSpaces": [
{
"accentColor": "xyz789",
"accessPolicy": "abc123",
"accounts": [AccountSpace],
"actionPlan": [ActionPlan],
"audienceLogo": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"audienceLogoMedia": Media,
"audienceName": "abc123",
"audienceThumbnail": Media,
"author": User,
"bannerImage": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "abc123",
"externalParticipants": [
SpaceExternalParticipant
],
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"internalParticipants": [
SpaceInternalParticipant
],
"isTemplateEphemeral": true,
"metadata": {},
"name": "abc123",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"passwordRequired": false,
"passwords": [SpacePassword],
"pointOfContact": User,
"pointOfContactId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"primaryColor": "xyz789",
"resources": [SpaceResource],
"spaceActionPlanItemResponses": [
ActionPlanItemResponse
],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceBlocks": [SpaceBlock],
"spaceMemoryEntries": [SpaceMemoryEntry],
"spaceParticipantMetrics": ReportSpaceParticipantMetric,
"spaceParticipantSessionTotals": [
ReportSpaceParticipantSessionTotal
],
"spaceParticipants": [SpaceParticipant],
"spaceSessionDurations": [
ReportSpaceSessionDuration
],
"spaceSessionStatistics": ReportSpaceSessionStatistic,
"template": SpaceTemplate,
"templateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"thumbnailOverride": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"workflowState": "abc123"
}
]
}
}
getViewerStories
Response
Returns [Story!]!
Arguments
| Name | Description |
|---|---|
input - GetViewerStoriesInput
|
Example
Query
query getViewerStories($input: GetViewerStoriesInput) {
getViewerStories(input: $input) {
author {
...UserFragment
}
canonicalName
collection {
...CollectionsV2Fragment
}
commentCounts {
...StoryCommentsCountFragment
}
createdAt
createdBy
description
descriptionPlaintext
duration
id
isDeleted
isPublic
memberOf {
...CollectionMemberV2Fragment
}
members {
...CollectionMemberV2Fragment
}
name
nodeId
organizationId
playbackMedia {
...StoryPlaybackMediaFragment
}
presentation
preview {
...MediaFragment
}
previewMediaId
publishStatus {
...StoryPublishStatusFragment
}
storyPreference {
...StoryPreferenceFragment
}
storyPreferences {
...StoryPreferenceFragment
}
tags {
...TagFragment
}
updatedAt
viewAnalytics {
...AnalyticsStoryViewCountFragment
}
visibility
}
}
Variables
{"input": GetViewerStoriesInput}
Response
{
"data": {
"getViewerStories": [
{
"author": User,
"canonicalName": "xyz789",
"collection": CollectionsV2,
"commentCounts": StoryCommentsCount,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"descriptionPlaintext": "xyz789",
"duration": BigFloat,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"isPublic": false,
"memberOf": [CollectionMemberV2],
"members": [CollectionMemberV2],
"name": "abc123",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"playbackMedia": StoryPlaybackMedia,
"presentation": "abc123",
"preview": Media,
"previewMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"publishStatus": StoryPublishStatus,
"storyPreference": StoryPreference,
"storyPreferences": StoryPreference,
"tags": [Tag],
"updatedAt": Datetime,
"viewAnalytics": AnalyticsStoryViewCount,
"visibility": "abc123"
}
]
}
}
librarySearch
Response
Returns [LibrarySearchResult!]
Arguments
| Name | Description |
|---|---|
input - LibrarySearchInput!
|
Example
Query
query librarySearch($input: LibrarySearchInput!) {
librarySearch(input: $input) {
createdBy
description
duration
fileSize
height
id
libraryId
libraryItem {
...LibraryItemFragment
}
meta
name
organizationId
relevance
updatedAt
width
}
}
Variables
{"input": LibrarySearchInput}
Response
{
"data": {
"librarySearch": [
{
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "xyz789",
"duration": 123,
"fileSize": 123,
"height": 987,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryItem": LibraryItem,
"meta": {},
"name": "abc123",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"relevance": "xyz789",
"updatedAt": Datetime,
"width": 987
}
]
}
}
space
Example
Query
query space($id: UUID!) {
space(id: $id) {
accentColor
accessPolicy
accounts {
...AccountSpaceFragment
}
actionPlan {
...ActionPlanFragment
}
audienceLogo
audienceLogoMedia {
...MediaFragment
}
audienceName
audienceThumbnail {
...MediaFragment
}
author {
...UserFragment
}
bannerImage
createdAt
createdBy
deletedAt
description
externalParticipants {
...SpaceExternalParticipantFragment
}
id
internalParticipants {
...SpaceInternalParticipantFragment
}
isTemplateEphemeral
metadata
name
nodeId
organization {
...OrganizationFragment
}
organizationId
passwordRequired
passwords {
...SpacePasswordFragment
}
pointOfContact {
...UserFragment
}
pointOfContactId
primaryColor
resources {
...SpaceResourceFragment
}
spaceActionPlanItemResponses {
...ActionPlanItemResponseFragment
}
spaceActivityEvents {
...SpaceActivityEventFragment
}
spaceBlocks {
...SpaceBlockFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
spaceParticipantMetrics {
...ReportSpaceParticipantMetricFragment
}
spaceParticipantSessionTotals {
...ReportSpaceParticipantSessionTotalFragment
}
spaceParticipants {
...SpaceParticipantFragment
}
spaceSessionDurations {
...ReportSpaceSessionDurationFragment
}
spaceSessionStatistics {
...ReportSpaceSessionStatisticFragment
}
template {
...SpaceTemplateFragment
}
templateId
thumbnailOverride
updatedAt
workflowState
}
}
Variables
{
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
Response
{
"data": {
"space": {
"accentColor": "xyz789",
"accessPolicy": "xyz789",
"accounts": [AccountSpace],
"actionPlan": [ActionPlan],
"audienceLogo": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"audienceLogoMedia": Media,
"audienceName": "abc123",
"audienceThumbnail": Media,
"author": User,
"bannerImage": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "abc123",
"externalParticipants": [SpaceExternalParticipant],
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"internalParticipants": [SpaceInternalParticipant],
"isTemplateEphemeral": true,
"metadata": {},
"name": "xyz789",
"nodeId": 4,
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"passwordRequired": true,
"passwords": [SpacePassword],
"pointOfContact": User,
"pointOfContactId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"primaryColor": "xyz789",
"resources": [SpaceResource],
"spaceActionPlanItemResponses": [
ActionPlanItemResponse
],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceBlocks": [SpaceBlock],
"spaceMemoryEntries": [SpaceMemoryEntry],
"spaceParticipantMetrics": ReportSpaceParticipantMetric,
"spaceParticipantSessionTotals": [
ReportSpaceParticipantSessionTotal
],
"spaceParticipants": [SpaceParticipant],
"spaceSessionDurations": [
ReportSpaceSessionDuration
],
"spaceSessionStatistics": ReportSpaceSessionStatistic,
"template": SpaceTemplate,
"templateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"thumbnailOverride": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"workflowState": "xyz789"
}
}
}
spaceSearch
Response
Returns [SpaceSearchResult!]
Arguments
| Name | Description |
|---|---|
input - SpaceSearchInput!
|
Example
Query
query spaceSearch($input: SpaceSearchInput!) {
spaceSearch(input: $input) {
audienceName
createdBy
description
id
metadata
name
organizationId
relevance
updatedAt
}
}
Variables
{"input": SpaceSearchInput}
Response
{
"data": {
"spaceSearch": [
{
"audienceName": "xyz789",
"createdBy": "abc123",
"description": "abc123",
"id": "4",
"metadata": "xyz789",
"name": "xyz789",
"organizationId": "abc123",
"relevance": "xyz789",
"updatedAt": "xyz789"
}
]
}
}
universeSearch
Response
Returns a UniverseSearchResult
Arguments
| Name | Description |
|---|---|
input - UniverseSearchInput!
|
Example
Query
query universeSearch($input: UniverseSearchInput!) {
universeSearch(input: $input) {
results {
...UniverseSearchResultGroupFragment
}
}
}
Variables
{"input": UniverseSearchInput}
Response
{
"data": {
"universeSearch": {
"results": [UniverseSearchResultGroup]
}
}
}
users
Response
Returns [User!]!
Example
Query
query users {
users {
_legalWhoops
actionItems {
...ActionPlanItemFragment
}
actionPlans {
...ActionPlanFragment
}
addedLibraryItemTags {
...LibraryItemTagFragment
}
analyticsStoryViews {
...AnalyticsStoryViewerFragment
}
assignedActionItems {
...ActionPlanItemFragment
}
authProviderId
authProviderMeta
authorOfSpaces {
...SpaceFragment
}
avatar {
...MediaFragment
}
avatarMediaId
boards {
...BoardFragment
}
cardNarrationsByNarratedBy {
...CardNarrationFragment
}
cards {
...CardFragment
}
collectionMemberPreviews {
...CollectionMemberPreviewV2Fragment
}
collectionMembers {
...CollectionMemberV2Fragment
}
collectionsV2 {
...CollectionsV2Fragment
}
createdActionPlanSections {
...ActionPlanSectionFragment
}
createdAt
email
id
lastEditedTemplates {
...SpaceTemplateFragment
}
legal {
...UserLegalFragment
}
libraryItems {
...LibraryItemFragment
}
libraryTags {
...LibraryTagFragment
}
memberOf {
...OrganizationFragment
}
metrics {
...MetricFragment
}
organization {
...OrganizationFragment
}
ownedAccounts {
...AccountFragment
}
pointOfContactOfSpaces {
...SpaceFragment
}
preferences {
...UserPrefsFragment
}
profile {
...UserProfilesV2Fragment
}
profile_v2 {
...UserProfilesV2Fragment
}
reportAllUserStorySessionsOverTimes {
...ReportAllUserStorySessionsOverTimeFragment
}
reportAvgViewsPerCardOverTimeForUsers {
...ReportAvgViewsPerCardOverTimeForUserFragment
}
reportCardViewsByViewedBy {
...ReportCardViewFragment
}
reportNumCardsViewedPerStoryForTimePeriodForUsers {
...ReportNumCardsViewedPerStoryForTimePeriodForUserFragment
}
reportSessionsListDuringTimePeriodV2SByViewedBy {
...ReportSessionsListDuringTimePeriodV2Fragment
}
reportStoryAllMemberViewersByViewedBy {
...ReportStoryAllMemberViewerFragment
}
reportStoryAllViewersByViewedBy {
...ReportStoryAllViewerFragment
}
reportStoryAllViewersV2SByViewedBy {
...ReportStoryAllViewersV2Fragment
}
reportTotalUserStorySessionsDuringTimePeriods {
...ReportTotalUserStorySessionsDuringTimePeriodFragment
}
reportUserCardViewsListDuringTimePeriodsByViewedBy {
...ReportUserCardViewsListDuringTimePeriodFragment
}
reportViewersListDuringTimePeriodsByViewedBy {
...ReportViewersListDuringTimePeriodFragment
}
responses {
...ActionPlanItemResponseFragment
}
spaceActivityEvents {
...SpaceActivityEventFragment
}
spaceInternalParticipants {
...SpaceInternalParticipantFragment
}
spaceTemplates {
...SpaceTemplateFragment
}
status
stories {
...StoryFragment
}
storyCommentsByCreatedBy {
...StoryCommentFragment
}
storyPublishesByPublishedBy {
...StoryPublishFragment
}
storyViews {
...ReportStoryViewFragment
}
tags {
...TagFragment
}
title
updatedAt
viewerPageTimeSpent {
...LibraryItemViewerPageTimeSpentFragment
}
viewerTimeSpent {
...LibraryItemViewerTimeSpentFragment
}
}
}
Response
{
"data": {
"users": [
{
"_legalWhoops": {},
"actionItems": [ActionPlanItem],
"actionPlans": [ActionPlan],
"addedLibraryItemTags": [LibraryItemTag],
"analyticsStoryViews": [AnalyticsStoryViewer],
"assignedActionItems": [ActionPlanItem],
"authProviderId": "xyz789",
"authProviderMeta": {},
"authorOfSpaces": [Space],
"avatar": Media,
"avatarMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"boards": [Board],
"cardNarrationsByNarratedBy": [CardNarration],
"cards": [Card],
"collectionMemberPreviews": [
CollectionMemberPreviewV2
],
"collectionMembers": [CollectionMemberV2],
"collectionsV2": [CollectionsV2],
"createdActionPlanSections": [ActionPlanSection],
"createdAt": Datetime,
"email": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"lastEditedTemplates": [SpaceTemplate],
"legal": UserLegal,
"libraryItems": [LibraryItem],
"libraryTags": [LibraryTag],
"memberOf": [Organization],
"metrics": [Metric],
"organization": Organization,
"ownedAccounts": [Account],
"pointOfContactOfSpaces": [Space],
"preferences": UserPrefs,
"profile": UserProfilesV2,
"profile_v2": [UserProfilesV2],
"reportAllUserStorySessionsOverTimes": [
ReportAllUserStorySessionsOverTime
],
"reportAvgViewsPerCardOverTimeForUsers": [
ReportAvgViewsPerCardOverTimeForUser
],
"reportCardViewsByViewedBy": [ReportCardView],
"reportNumCardsViewedPerStoryForTimePeriodForUsers": [
ReportNumCardsViewedPerStoryForTimePeriodForUser
],
"reportSessionsListDuringTimePeriodV2SByViewedBy": [
ReportSessionsListDuringTimePeriodV2
],
"reportStoryAllMemberViewersByViewedBy": [
ReportStoryAllMemberViewer
],
"reportStoryAllViewersByViewedBy": [
ReportStoryAllViewer
],
"reportStoryAllViewersV2SByViewedBy": [
ReportStoryAllViewersV2
],
"reportTotalUserStorySessionsDuringTimePeriods": [
ReportTotalUserStorySessionsDuringTimePeriod
],
"reportUserCardViewsListDuringTimePeriodsByViewedBy": [
ReportUserCardViewsListDuringTimePeriod
],
"reportViewersListDuringTimePeriodsByViewedBy": [
ReportViewersListDuringTimePeriod
],
"responses": [ActionPlanItemResponse],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceInternalParticipants": [
SpaceInternalParticipant
],
"spaceTemplates": [SpaceTemplate],
"status": "abc123",
"stories": [Story],
"storyCommentsByCreatedBy": [StoryComment],
"storyPublishesByPublishedBy": [StoryPublish],
"storyViews": [ReportStoryView],
"tags": [Tag],
"title": "abc123",
"updatedAt": Datetime,
"viewerPageTimeSpent": [
LibraryItemViewerPageTimeSpent
],
"viewerTimeSpent": [LibraryItemViewerTimeSpent]
}
]
}
}
Mutations
addInternalParticipantToSpace
Response
Returns a SpaceInternalParticipant!
Arguments
| Name | Description |
|---|---|
input - AddInternalParticipantToSpaceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation addInternalParticipantToSpace($input: AddInternalParticipantToSpaceInput!) {
addInternalParticipantToSpace(input: $input) {
createdAt
createdBy
id
space {
...SpaceFragment
}
spaceId
updatedAt
user {
...UserFragment
}
userId
}
}
Variables
{"input": AddInternalParticipantToSpaceInput}
Response
{
"data": {
"addInternalParticipantToSpace": {
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
}
}
addStoryBlockToSpace
Response
Returns a SpaceBlock!
Arguments
| Name | Description |
|---|---|
input - AddStoryBlockToSpaceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation addStoryBlockToSpace($input: AddStoryBlockToSpaceInput!) {
addStoryBlockToSpace(input: $input) {
block {
...BlockFragment
}
blockId
blockName
blockType
createdAt
createdBy
id
nodeId
position
props
space {
...SpaceFragment
}
spaceId
updatedAt
visibility
}
}
Variables
{"input": AddStoryBlockToSpaceInput}
Response
{
"data": {
"addStoryBlockToSpace": {
"block": Block,
"blockId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"blockName": "xyz789",
"blockType": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"position": 123,
"props": {},
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"visibility": "abc123"
}
}
}
createAccount
Response
Returns a CreateAccountResult!
Arguments
| Name | Description |
|---|---|
input - CreateAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAccount($input: CreateAccountInput!) {
createAccount(input: $input) {
avatarMediaId
createdAt
createdBy
id
isDeleted
name
organizationId
ownedBy
updatedAt
website
}
}
Variables
{"input": CreateAccountInput}
Response
{
"data": {
"createAccount": {
"avatarMediaId": 4,
"createdAt": Datetime,
"createdBy": 4,
"id": 4,
"isDeleted": true,
"name": "abc123",
"organizationId": "4",
"ownedBy": 4,
"updatedAt": Datetime,
"website": "abc123"
}
}
}
createMemoryEntryForAccount
Response
Returns a MemoryEntry!
Arguments
| Name | Description |
|---|---|
input - CreateMemoryEntryForAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createMemoryEntryForAccount($input: CreateMemoryEntryForAccountInput!) {
createMemoryEntryForAccount(input: $input) {
accountMemoryEntries {
...AccountMemoryEntryFragment
}
content
createdAt
createdBy
embedding
id
isDeleted
nodeId
organization {
...OrganizationFragment
}
organizationId
organizationMemoryEntries {
...OrganizationMemoryEntryFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
updatedAt
updatedBy
}
}
Variables
{"input": CreateMemoryEntryForAccountInput}
Response
{
"data": {
"createMemoryEntryForAccount": {
"accountMemoryEntries": [AccountMemoryEntry],
"content": "abc123",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"embedding": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"nodeId": 4,
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationMemoryEntries": [
OrganizationMemoryEntry
],
"spaceMemoryEntries": [SpaceMemoryEntry],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
}
}
createMemoryEntryForSpace
Response
Returns a MemoryEntry!
Arguments
| Name | Description |
|---|---|
input - CreateMemoryEntryForSpaceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createMemoryEntryForSpace($input: CreateMemoryEntryForSpaceInput!) {
createMemoryEntryForSpace(input: $input) {
accountMemoryEntries {
...AccountMemoryEntryFragment
}
content
createdAt
createdBy
embedding
id
isDeleted
nodeId
organization {
...OrganizationFragment
}
organizationId
organizationMemoryEntries {
...OrganizationMemoryEntryFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
updatedAt
updatedBy
}
}
Variables
{"input": CreateMemoryEntryForSpaceInput}
Response
{
"data": {
"createMemoryEntryForSpace": {
"accountMemoryEntries": [AccountMemoryEntry],
"content": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"embedding": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationMemoryEntries": [
OrganizationMemoryEntry
],
"spaceMemoryEntries": [SpaceMemoryEntry],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
}
}
createSpace
Response
Returns a Space!
Arguments
| Name | Description |
|---|---|
input - CreateSpaceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createSpace($input: CreateSpaceInput!) {
createSpace(input: $input) {
accentColor
accessPolicy
accounts {
...AccountSpaceFragment
}
actionPlan {
...ActionPlanFragment
}
audienceLogo
audienceLogoMedia {
...MediaFragment
}
audienceName
audienceThumbnail {
...MediaFragment
}
author {
...UserFragment
}
bannerImage
createdAt
createdBy
deletedAt
description
externalParticipants {
...SpaceExternalParticipantFragment
}
id
internalParticipants {
...SpaceInternalParticipantFragment
}
isTemplateEphemeral
metadata
name
nodeId
organization {
...OrganizationFragment
}
organizationId
passwordRequired
passwords {
...SpacePasswordFragment
}
pointOfContact {
...UserFragment
}
pointOfContactId
primaryColor
resources {
...SpaceResourceFragment
}
spaceActionPlanItemResponses {
...ActionPlanItemResponseFragment
}
spaceActivityEvents {
...SpaceActivityEventFragment
}
spaceBlocks {
...SpaceBlockFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
spaceParticipantMetrics {
...ReportSpaceParticipantMetricFragment
}
spaceParticipantSessionTotals {
...ReportSpaceParticipantSessionTotalFragment
}
spaceParticipants {
...SpaceParticipantFragment
}
spaceSessionDurations {
...ReportSpaceSessionDurationFragment
}
spaceSessionStatistics {
...ReportSpaceSessionStatisticFragment
}
template {
...SpaceTemplateFragment
}
templateId
thumbnailOverride
updatedAt
workflowState
}
}
Variables
{"input": CreateSpaceInput}
Response
{
"data": {
"createSpace": {
"accentColor": "xyz789",
"accessPolicy": "abc123",
"accounts": [AccountSpace],
"actionPlan": [ActionPlan],
"audienceLogo": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"audienceLogoMedia": Media,
"audienceName": "xyz789",
"audienceThumbnail": Media,
"author": User,
"bannerImage": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "xyz789",
"externalParticipants": [SpaceExternalParticipant],
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"internalParticipants": [SpaceInternalParticipant],
"isTemplateEphemeral": false,
"metadata": {},
"name": "xyz789",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"passwordRequired": false,
"passwords": [SpacePassword],
"pointOfContact": User,
"pointOfContactId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"primaryColor": "xyz789",
"resources": [SpaceResource],
"spaceActionPlanItemResponses": [
ActionPlanItemResponse
],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceBlocks": [SpaceBlock],
"spaceMemoryEntries": [SpaceMemoryEntry],
"spaceParticipantMetrics": ReportSpaceParticipantMetric,
"spaceParticipantSessionTotals": [
ReportSpaceParticipantSessionTotal
],
"spaceParticipants": [SpaceParticipant],
"spaceSessionDurations": [
ReportSpaceSessionDuration
],
"spaceSessionStatistics": ReportSpaceSessionStatistic,
"template": SpaceTemplate,
"templateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"thumbnailOverride": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"workflowState": "abc123"
}
}
}
updateMemoryEntryForAccount
Response
Returns a MemoryEntry!
Arguments
| Name | Description |
|---|---|
input - UpdateMemoryEntryForAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMemoryEntryForAccount($input: UpdateMemoryEntryForAccountInput!) {
updateMemoryEntryForAccount(input: $input) {
accountMemoryEntries {
...AccountMemoryEntryFragment
}
content
createdAt
createdBy
embedding
id
isDeleted
nodeId
organization {
...OrganizationFragment
}
organizationId
organizationMemoryEntries {
...OrganizationMemoryEntryFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
updatedAt
updatedBy
}
}
Variables
{"input": UpdateMemoryEntryForAccountInput}
Response
{
"data": {
"updateMemoryEntryForAccount": {
"accountMemoryEntries": [AccountMemoryEntry],
"content": "abc123",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"embedding": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"nodeId": 4,
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationMemoryEntries": [
OrganizationMemoryEntry
],
"spaceMemoryEntries": [SpaceMemoryEntry],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
}
}
updateMemoryEntryForSpace
Response
Returns a MemoryEntry!
Arguments
| Name | Description |
|---|---|
input - UpdateMemoryEntryForSpaceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMemoryEntryForSpace($input: UpdateMemoryEntryForSpaceInput!) {
updateMemoryEntryForSpace(input: $input) {
accountMemoryEntries {
...AccountMemoryEntryFragment
}
content
createdAt
createdBy
embedding
id
isDeleted
nodeId
organization {
...OrganizationFragment
}
organizationId
organizationMemoryEntries {
...OrganizationMemoryEntryFragment
}
spaceMemoryEntries {
...SpaceMemoryEntryFragment
}
updatedAt
updatedBy
}
}
Variables
{"input": UpdateMemoryEntryForSpaceInput}
Response
{
"data": {
"updateMemoryEntryForSpace": {
"accountMemoryEntries": [AccountMemoryEntry],
"content": "abc123",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"embedding": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationMemoryEntries": [
OrganizationMemoryEntry
],
"spaceMemoryEntries": [SpaceMemoryEntry],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
}
}
Types
Account
Fields
| Field Name | Description |
|---|---|
accountMemoryEntries - [AccountMemoryEntry!]!
|
Reads and enables pagination through a set of AccountMemoryEntry. |
avatarMedia - Media
|
Reads a single Media that is related to this Account. |
avatarMediaId - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
ownedBy - UUID
|
|
owner - User
|
Reads a single User that is related to this Account. |
spaces - [AccountSpace!]!
|
Reads and enables pagination through a set of AccountSpace. |
updatedAt - Datetime
|
|
website - String
|
|
Example
{
"accountMemoryEntries": [AccountMemoryEntry],
"avatarMedia": Media,
"avatarMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"name": "abc123",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"ownedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"owner": User,
"spaces": [AccountSpace],
"updatedAt": Datetime,
"website": "xyz789"
}
AccountMemoryEntry
Fields
| Field Name | Description |
|---|---|
account - Account
|
Reads a single Account that is related to this AccountMemoryEntry. |
accountId - UUID
|
|
createdAt - Datetime
|
|
id - UUID!
|
|
memoryEntry - MemoryEntry
|
Reads a single MemoryEntry that is related to this AccountMemoryEntry. |
memoryEntryId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
Example
{
"account": Account,
"accountId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memoryEntry": MemoryEntry,
"memoryEntryId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4"
}
AccountSearchInput
AccountSearchResult
Example
{
"createdBy": "abc123",
"id": "4",
"name": "abc123",
"organizationId": "xyz789",
"relevance": "abc123",
"updatedAt": "xyz789",
"website": "xyz789"
}
AccountSpace
Fields
| Field Name | Description |
|---|---|
account - Account
|
Reads a single Account that is related to this AccountSpace. |
accountId - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
space - Space
|
Reads a single Space that is related to this AccountSpace. |
spaceId - UUID
|
Example
{
"account": Account,
"accountId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ActionPlan
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this ActionPlan. |
copiedFromActionPlanId - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
isTemplate - Boolean
|
|
itemResponses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
items - [ActionPlanItem!]!
|
Reads and enables pagination through a set of ActionPlanItem. |
metadata - JSON
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this ActionPlan. |
organizationId - UUID
|
|
planStats - ActionPlanStat
|
Reads a single ActionPlanStat that is related to this ActionPlan. |
sections - [ActionPlanSection!]!
|
Reads and enables pagination through a set of ActionPlanSection. |
space - Space
|
Reads a single Space that is related to this ActionPlan. |
spaceId - UUID
|
|
updatedAt - Datetime
|
|
Example
{
"author": User,
"copiedFromActionPlanId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"isTemplate": false,
"itemResponses": [ActionPlanItemResponse],
"items": [ActionPlanItem],
"metadata": {},
"name": "xyz789",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"planStats": ActionPlanStat,
"sections": [ActionPlanSection],
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime
}
ActionPlanItem
Fields
| Field Name | Description |
|---|---|
actionPlan - ActionPlan
|
Reads a single ActionPlan that is related to this ActionPlanItem. |
actionPlanId - UUID
|
|
actionSection - ActionPlanSection
|
Reads a single ActionPlanSection that is related to this ActionPlanItem. |
assigneeParticipantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this ActionPlanItem. |
assigneeParticipantProfileId - UUID
|
|
assigneeUser - User
|
Reads a single User that is related to this ActionPlanItem. |
assigneeUserId - UUID
|
|
author - User
|
Reads a single User that is related to this ActionPlanItem. |
completedAt - Datetime
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
dueAt - Datetime
|
|
formConfig - ActionPlanItemFormConfig
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
metadata - JSON
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
position - Int
|
|
responseCount - Int!
|
|
responses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
section - String
|
|
sectionId - UUID
|
|
status - String
|
|
title - String
|
|
type - String
|
|
updatedAt - Datetime
|
|
userLatestResponse - ActionPlanItemResponse
|
|
visibility - String
|
|
Example
{
"actionPlan": ActionPlan,
"actionPlanId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"actionSection": ActionPlanSection,
"assigneeParticipantProfile": ParticipantProfile,
"assigneeParticipantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"assigneeUser": User,
"assigneeUserId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"author": User,
"completedAt": Datetime,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"dueAt": Datetime,
"formConfig": ActionPlanItemFormConfig,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"metadata": {},
"nodeId": 4,
"position": 123,
"responseCount": 987,
"responses": [ActionPlanItemResponse],
"section": "xyz789",
"sectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"status": "xyz789",
"title": "abc123",
"type": "xyz789",
"updatedAt": Datetime,
"userLatestResponse": ActionPlanItemResponse,
"visibility": "xyz789"
}
ActionPlanItemFormConfig
ActionPlanItemResponse
Fields
| Field Name | Description |
|---|---|
actionPlan - ActionPlan
|
Reads a single ActionPlan that is related to this ActionPlanItemResponse. |
actionPlanId - UUID
|
|
actionPlanItem - ActionPlanItem
|
Reads a single ActionPlanItem that is related to this ActionPlanItemResponse. |
actionPlanItemId - UUID
|
|
createdAt - Datetime
|
|
id - UUID!
|
|
media - Media
|
Reads a single Media that is related to this ActionPlanItemResponse. |
mediaId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
responseData - JSON
|
|
space - Space
|
Reads a single Space that is related to this ActionPlanItemResponse. |
spaceId - UUID
|
|
submittedByParticipantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this ActionPlanItemResponse. |
submittedByParticipantProfileId - UUID
|
|
submittedByUser - User
|
Reads a single User that is related to this ActionPlanItemResponse. |
submittedByUserId - UUID
|
|
submittedEmail - String
|
|
submittedIpHash - String
|
|
updatedAt - Datetime
|
Example
{
"actionPlan": ActionPlan,
"actionPlanId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"actionPlanItem": ActionPlanItem,
"actionPlanItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"responseData": {},
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"submittedByParticipantProfile": ParticipantProfile,
"submittedByParticipantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"submittedByUser": User,
"submittedByUserId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"submittedEmail": "abc123",
"submittedIpHash": "abc123",
"updatedAt": Datetime
}
ActionPlanSection
Fields
| Field Name | Description |
|---|---|
actionItems - [ActionPlanItem!]!
|
Reads and enables pagination through a set of ActionPlanItem. |
actionPlan - ActionPlan
|
Reads a single ActionPlan that is related to this ActionPlanSection. |
actionPlanId - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
createdByUser - User
|
Reads a single User that is related to this ActionPlanSection. |
id - UUID!
|
|
isDeleted - Boolean
|
|
metadata - JSON
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
position - Int
|
|
updatedAt - Datetime
|
|
Example
{
"actionItems": [ActionPlanItem],
"actionPlan": ActionPlan,
"actionPlanId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdByUser": User,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"metadata": {},
"name": "abc123",
"nodeId": "4",
"position": 123,
"updatedAt": Datetime
}
ActionPlanStat
Fields
| Field Name | Description |
|---|---|
actionPlan - ActionPlan
|
Reads a single ActionPlan that is related to this ActionPlanStat. |
actionPlanId - UUID!
|
|
completedCount - BigInt
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
sectionCount - BigInt
|
|
totalCount - BigInt
|
|
visibleCompletedCount - BigInt
|
|
visibleCount - BigInt
|
Example
{
"actionPlan": ActionPlan,
"actionPlanId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"completedCount": {},
"nodeId": 4,
"sectionCount": {},
"totalCount": {},
"visibleCompletedCount": {},
"visibleCount": {}
}
AddInternalParticipantToSpaceInput
AddStoryBlockToSpaceInput
AnalyticsStoryViewCount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this AnalyticsStoryViewCount. |
storyId - UUID!
|
|
totalViews - BigInt
|
|
viewAnalytics - Story
|
Reads a single Story that is related to this AnalyticsStoryViewCount. |
Example
{
"nodeId": "4",
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalViews": {},
"viewAnalytics": Story
}
AnalyticsStoryViewer
Example
{
"lastViewed": Datetime,
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewCount": {},
"viewerId": "abc123"
}
Background
BigFloat
Description
A floating point number that requires more precision than IEEE 754 binary 64
Example
BigFloat
BigInt
Description
A signed eight-byte integer. The upper big integer values are greater than the max value for a JavaScript number. Therefore all big integers will be output as strings and not numbers.
Example
{}
Block
Fields
| Field Name | Description |
|---|---|
blockResources - [BlockResource!]!
|
Reads and enables pagination through a set of BlockResource. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
deletedAt - Datetime
|
|
description - String
|
|
id - UUID!
|
|
metadata - JSON
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
props - JSON
|
|
spaceActivityEvents - [SpaceActivityEvent!]!
|
Reads and enables pagination through a set of SpaceActivityEvent. |
spaceBlocks - [SpaceBlock!]!
|
Reads and enables pagination through a set of SpaceBlock. |
type - String
|
|
updatedAt - Datetime
|
|
Example
{
"blockResources": [BlockResource],
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"name": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"props": {},
"spaceActivityEvents": [SpaceActivityEvent],
"spaceBlocks": [SpaceBlock],
"type": "xyz789",
"updatedAt": Datetime
}
BlockResource
Fields
| Field Name | Description |
|---|---|
block - Block
|
Reads a single Block that is related to this BlockResource. |
blockId - UUID
|
|
blockType - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this BlockResource. |
libraryItemId - UUID
|
|
metadata - JSON
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
position - Int
|
|
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this BlockResource. |
storyId - UUID
|
|
updatedAt - Datetime
|
Example
{
"block": Block,
"blockId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"blockType": "abc123",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"nodeId": "4",
"position": 987,
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime
}
Board
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this Board. |
canonicalName - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
isPublic - Boolean
|
|
memberOf - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
members - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
presentation - String
|
|
preview - [BoardPreviewImage!]!
|
Reads and enables pagination through a set of BoardPreviewImage. |
storyCount - BoardStoryCount
|
Reads a single BoardStoryCount that is related to this Board. |
tags - [Tag!]!
|
Reads and enables pagination through a set of Tag. |
updatedAt - Datetime
|
|
visibility - String
|
|
Example
{
"author": User,
"canonicalName": "abc123",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"isPublic": false,
"memberOf": [CollectionMemberV2],
"members": [CollectionMemberV2],
"name": "abc123",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"presentation": "abc123",
"preview": [BoardPreviewImage],
"storyCount": BoardStoryCount,
"tags": [Tag],
"updatedAt": Datetime,
"visibility": "abc123"
}
BoardPreviewImage
Example
{
"board": Board,
"boardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"previewMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
BoardStoryCount
Boolean
Description
The Boolean scalar type represents true or false.
BrandKit
Fields
| Field Name | Description |
|---|---|
backgrounds - [Background!]
|
|
colors - [Color!]
|
|
fonts - [BrandKitFont!]
|
|
logos - Logos
|
Example
{
"backgrounds": [Background],
"colors": [Color],
"fonts": [BrandKitFont],
"logos": Logos
}
BrandKitFont
Card
Fields
| Field Name | Description |
|---|---|
activeLayers - JSON
|
|
author - User
|
Reads a single User that is related to this Card. |
canonicalName - String
|
|
cardNarrations - [CardNarration!]!
|
Reads and enables pagination through a set of CardNarration. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
deprecatedHighlights - JSON
|
|
duration - Int
|
|
exclude - Boolean
|
|
expiresAt - Datetime
|
|
graph - JSON
|
|
hotspots - JSON
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
layers - JSON
|
|
layout - JSON
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
previewMedia - Media
|
Reads a single Media that is related to this Card. |
previewMediaId - UUID
|
|
publishedAt - Datetime
|
|
publishedBy - UUID
|
|
reactions - [Reaction!]!
|
Reads and enables pagination through a set of Reaction. |
relatedMedia - [CardMediaRelation!]
|
|
reportAvgViewsPerCardOverTimeForAnonUsers - [ReportAvgViewsPerCardOverTimeForAnonUser!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTimeForAnonUser. |
reportAvgViewsPerCardOverTimeForUsers - [ReportAvgViewsPerCardOverTimeForUser!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTimeForUser. |
reportAvgViewsPerCardOverTimes - [ReportAvgViewsPerCardOverTime!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTime. |
reportCardViewsListDuringTimePeriods - [ReportCardViewsListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportCardViewsListDuringTimePeriod. |
reportUserCardViewsListDuringTimePeriods - [ReportUserCardViewsListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportUserCardViewsListDuringTimePeriod. |
totalViews - BigInt
|
|
transcript - [CardTranscript!]!
|
Reads and enables pagination through a set of CardTranscript. |
transitionRule - JSON
|
|
updatedAt - Datetime
|
|
viewerHasViewed - Boolean!
|
|
views - [ReportCardView!]!
|
Reads and enables pagination through a set of ReportCardView. |
Example
{
"activeLayers": {},
"author": User,
"canonicalName": "xyz789",
"cardNarrations": [CardNarration],
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deprecatedHighlights": {},
"duration": 987,
"exclude": true,
"expiresAt": Datetime,
"graph": {},
"hotspots": {},
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"layers": {},
"layout": {},
"name": "abc123",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"previewMedia": Media,
"previewMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"publishedAt": Datetime,
"publishedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"reactions": [Reaction],
"relatedMedia": [CardMediaRelation],
"reportAvgViewsPerCardOverTimeForAnonUsers": [
ReportAvgViewsPerCardOverTimeForAnonUser
],
"reportAvgViewsPerCardOverTimeForUsers": [
ReportAvgViewsPerCardOverTimeForUser
],
"reportAvgViewsPerCardOverTimes": [
ReportAvgViewsPerCardOverTime
],
"reportCardViewsListDuringTimePeriods": [
ReportCardViewsListDuringTimePeriod
],
"reportUserCardViewsListDuringTimePeriods": [
ReportUserCardViewsListDuringTimePeriod
],
"totalViews": {},
"transcript": [CardTranscript],
"transitionRule": {},
"updatedAt": Datetime,
"viewerHasViewed": true,
"views": [ReportCardView]
}
CardMediaRelation
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
nodeKey - String
|
|
nodeValue - JSON
|
|
organizationId - UUID
|
|
primaryMedia - Media
|
Reads a single Media that is related to this CardMediaRelation. |
primaryMediaId - UUID
|
|
secondaryMedia - Media
|
Reads a single Media that is related to this CardMediaRelation. |
secondaryMediaId - UUID
|
Example
{
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeKey": "abc123",
"nodeValue": {},
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"primaryMedia": Media,
"primaryMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"secondaryMedia": Media,
"secondaryMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
CardNarration
Fields
| Field Name | Description |
|---|---|
card - Card
|
Reads a single Card that is related to this CardNarration. |
cardId - UUID
|
|
id - UUID
|
|
narratedBy - UUID
|
|
narrationLayerId - UUID
|
|
narrator - User
|
Reads a single User that is related to this CardNarration. |
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this CardNarration. |
storyId - UUID
|
Example
{
"card": Card,
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"narratedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"narrationLayerId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"narrator": User,
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
CardPlaybackMedia
Fields
| Field Name | Description |
|---|---|
cardId - UUID!
|
|
checksum - String!
|
|
createdAt - Datetime
|
|
documentId - UUID
|
|
id - UUID
|
|
isPublic - Boolean
|
|
media - Media
|
Reads a single Media that is related to this CardPlaybackMedia. |
mediaId - UUID
|
|
muxAssetId - String
|
|
muxPlaybackId - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
Example
{
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"checksum": "abc123",
"createdAt": Datetime,
"documentId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isPublic": true,
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"muxAssetId": "abc123",
"muxPlaybackId": "xyz789",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
CardTranscript
Fields
| Field Name | Description |
|---|---|
card - Card
|
Reads a single Card that is related to this CardTranscript. |
cardId - UUID
|
|
createdAt - Datetime
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
transcript - JSON
|
|
updatedAt - Datetime
|
Example
{
"card": Card,
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"transcript": {},
"updatedAt": Datetime
}
CollectionMemberPreviewV2
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this CollectionMemberPreviewV2. |
createdBy - UUID
|
|
description - String
|
|
id - UUID
|
|
media - [Media!]
|
Reads and enables pagination through a set of Media. |
member - CollectionMemberV2
|
Reads a single CollectionMemberV2 that is related to this CollectionMemberPreviewV2. |
name - String
|
|
Example
{
"author": User,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": [Media],
"member": CollectionMemberV2,
"name": "xyz789"
}
CollectionMemberV2
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this CollectionMemberV2. |
board - Board
|
Reads a single Board that is related to this CollectionMemberV2. |
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this CollectionMemberV2. |
collectionId - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
memberCardId - UUID
|
|
memberCollectionId - UUID
|
|
memberLibraryItemId - UUID
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
parentBoard - Board
|
Reads a single Board that is related to this CollectionMemberV2. |
parentSection - Section
|
Reads a single Section that is related to this CollectionMemberV2. |
parentStory - Story
|
Reads a single Story that is related to this CollectionMemberV2. |
position - Int
|
|
presentation - String
|
|
preview - CollectionMemberPreviewV2
|
Reads a single CollectionMemberPreviewV2 that is related to this CollectionMemberV2. |
section - Section
|
Reads a single Section that is related to this CollectionMemberV2. |
story - Story
|
Reads a single Story that is related to this CollectionMemberV2. |
updatedAt - Datetime
|
Example
{
"author": User,
"board": Board,
"collection": CollectionsV2,
"collectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memberCardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memberCollectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memberLibraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"name": "abc123",
"nodeId": "4",
"parentBoard": Board,
"parentSection": Section,
"parentStory": Story,
"position": 987,
"presentation": "xyz789",
"preview": CollectionMemberPreviewV2,
"section": Section,
"story": Story,
"updatedAt": Datetime
}
CollectionPresentation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOARD"
CollectionSearchInput
CollectionSearchResult
Example
{
"createdBy": "xyz789",
"description": "xyz789",
"id": 4,
"name": "abc123",
"organizationId": "abc123",
"presentation": "BOARD",
"relevance": 987.65,
"updatedAt": Datetime
}
CollectionsAi
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this CollectionsAi. |
collectionId - UUID
|
|
confidenceScore - BigFloat
|
|
createdAt - Datetime
|
|
feedback - String
|
|
feedbackComments - String
|
|
id - UUID!
|
|
metadata - JSON
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this CollectionsAi. |
organizationId - UUID
|
|
otherGeneratedResources - JSON
|
|
shortSummary - String
|
|
summary - String
|
|
title - String
|
|
transcriptHash - String
|
|
transcriptUsed - String
|
|
updatedAt - Datetime
|
Example
{
"collection": CollectionsV2,
"collectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"confidenceScore": BigFloat,
"createdAt": Datetime,
"feedback": "xyz789",
"feedbackComments": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"otherGeneratedResources": {},
"shortSummary": "abc123",
"summary": "xyz789",
"title": "abc123",
"transcriptHash": "xyz789",
"transcriptUsed": "abc123",
"updatedAt": Datetime
}
CollectionsV2
Fields
| Field Name | Description |
|---|---|
aiData - [CollectionsAi!]!
|
Reads and enables pagination through a set of CollectionsAi. |
author - User
|
Reads a single User that is related to this CollectionsV2. |
blocks - [BlockResource!]!
|
Reads and enables pagination through a set of BlockResource. |
canonicalName - String
|
|
cardNarrations - [CardNarration!]!
|
Reads and enables pagination through a set of CardNarration. |
cardViews - [ReportCardView!]!
|
Reads and enables pagination through a set of ReportCardView. |
childStoryViews - [ReportStoryView!]!
|
Reads and enables pagination through a set of ReportStoryView. |
commentCounts - StoryCommentsCount
|
Reads a single StoryCommentsCount that is related to this CollectionsV2. |
comments - [StoryComment!]!
|
Reads and enables pagination through a set of StoryComment. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
editors - [StoryGrant!]
|
|
hasViewed - Boolean!
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
isPublic - Boolean
|
|
latestStoryState - Story
|
Reads a single Story that is related to this CollectionsV2. |
members - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this CollectionsV2. |
organizationId - UUID
|
|
playbackMedia - StoryPlaybackMedia
|
Reads a single StoryPlaybackMedia that is related to this CollectionsV2. |
presentation - String
|
|
publishStatus - StoryPublishStatus
|
The publish status of the story |
reportAllAnonStorySessionsOverTimesByStoryId - [ReportAllAnonStorySessionsOverTime!]!
|
Reads and enables pagination through a set of ReportAllAnonStorySessionsOverTime. |
reportAllAnonStoryViewersOverTimesByStoryId - [ReportAllAnonStoryViewersOverTime!]!
|
Reads and enables pagination through a set of ReportAllAnonStoryViewersOverTime. |
reportAllAnonUserStorySessionsOverTimesByStoryId - [ReportAllAnonUserStorySessionsOverTime!]!
|
Reads and enables pagination through a set of ReportAllAnonUserStorySessionsOverTime. |
reportAllMemberStorySessionsOverTimesByStoryId - [ReportAllMemberStorySessionsOverTime!]!
|
Reads and enables pagination through a set of ReportAllMemberStorySessionsOverTime. |
reportAllMemberStoryViewersOverTimesByStoryId - [ReportAllMemberStoryViewersOverTime!]!
|
Reads and enables pagination through a set of ReportAllMemberStoryViewersOverTime. |
reportAllUserStorySessionsOverTimesByStoryId - [ReportAllUserStorySessionsOverTime!]!
|
Reads and enables pagination through a set of ReportAllUserStorySessionsOverTime. |
reportAvgViewsPerCardOverTimeForAnonUsersByStoryId - [ReportAvgViewsPerCardOverTimeForAnonUser!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTimeForAnonUser. |
reportAvgViewsPerCardOverTimeForUsersByStoryId - [ReportAvgViewsPerCardOverTimeForUser!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTimeForUser. |
reportAvgViewsPerCardOverTimesByStoryId - [ReportAvgViewsPerCardOverTime!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTime. |
reportCardViewsListDuringTimePeriodsByStoryId - [ReportCardViewsListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportCardViewsListDuringTimePeriod. |
reportNumCardsViewedPerStoryForTimePeriodForAnonUsersByStoryId - [ReportNumCardsViewedPerStoryForTimePeriodForAnonUser!]!
|
Reads and enables pagination through a set of ReportNumCardsViewedPerStoryForTimePeriodForAnonUser. |
reportNumCardsViewedPerStoryForTimePeriodForUsersByStoryId - [ReportNumCardsViewedPerStoryForTimePeriodForUser!]!
|
Reads and enables pagination through a set of ReportNumCardsViewedPerStoryForTimePeriodForUser. |
reportNumCardsViewedPerStoryForTimePeriodsByStoryId - [ReportNumCardsViewedPerStoryForTimePeriod!]!
|
Reads and enables pagination through a set of ReportNumCardsViewedPerStoryForTimePeriod. |
reportSessionsListDuringTimePeriodV2SByStoryId - [ReportSessionsListDuringTimePeriodV2!]!
|
Reads and enables pagination through a set of ReportSessionsListDuringTimePeriodV2. |
reportStoryAllAnonViewersByStoryId - [ReportStoryAllAnonViewer!]!
|
Reads and enables pagination through a set of ReportStoryAllAnonViewer. |
reportStoryAllAnonViewersTotalsByStoryId - [ReportStoryAllAnonViewersTotal!]!
|
Reads and enables pagination through a set of ReportStoryAllAnonViewersTotal. |
reportStoryAllMemberViewersByStoryId - [ReportStoryAllMemberViewer!]!
|
Reads and enables pagination through a set of ReportStoryAllMemberViewer. |
reportStoryAllMemberViewersTotalsByStoryId - [ReportStoryAllMemberViewersTotal!]!
|
Reads and enables pagination through a set of ReportStoryAllMemberViewersTotal. |
reportStoryAllViewersByStoryId - [ReportStoryAllViewer!]!
|
Reads and enables pagination through a set of ReportStoryAllViewer. |
reportStoryAllViewersV2SByStoryId - [ReportStoryAllViewersV2!]!
|
Reads and enables pagination through a set of ReportStoryAllViewersV2. |
reportTotalAnonStorySessionsDuringTimePeriodsByStoryId - [ReportTotalAnonStorySessionsDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalAnonStorySessionsDuringTimePeriod. |
reportTotalAnonStoryViewersDuringTimePeriodsByStoryId - [ReportTotalAnonStoryViewersDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalAnonStoryViewersDuringTimePeriod. |
reportTotalAnonUserStorySessionsDuringTimePeriodsByStoryId - [ReportTotalAnonUserStorySessionsDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalAnonUserStorySessionsDuringTimePeriod. |
reportTotalMemberStorySessionsDuringTimePeriodsByStoryId - [ReportTotalMemberStorySessionsDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalMemberStorySessionsDuringTimePeriod. |
reportTotalMemberStoryViewersDuringTimePeriodsByStoryId - [ReportTotalMemberStoryViewersDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalMemberStoryViewersDuringTimePeriod. |
reportTotalUserStorySessionsDuringTimePeriodsByStoryId - [ReportTotalUserStorySessionsDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalUserStorySessionsDuringTimePeriod. |
reportUserCardViewsListDuringTimePeriodsByStoryId - [ReportUserCardViewsListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportUserCardViewsListDuringTimePeriod. |
reportViewersListDuringTimePeriodsByStoryId - [ReportViewersListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportViewersListDuringTimePeriod. |
sharedWith - [StoryGrant!]
|
|
spaceResourcesByStoryId - [SpaceResource!]!
|
Reads and enables pagination through a set of SpaceResource. |
storyPreference - StoryPreference
|
The story preferences including custom thumbnail settings |
storyPreferences - StoryPreference
|
Reads a single StoryPreference that is related to this CollectionsV2. |
storyPublishCounts - StoryPublishCount
|
Reads a single StoryPublishCount that is related to this CollectionsV2. |
storyPublishes - [StoryPublish!]!
|
Reads and enables pagination through a set of StoryPublish. |
storyViewers - [AnalyticsStoryViewer!]!
|
Reads and enables pagination through a set of AnalyticsStoryViewer. |
storyViews - [ReportStoryView!]!
|
Reads and enables pagination through a set of ReportStoryView. |
tags - [Tag!]!
|
Reads and enables pagination through a set of Tag. |
updatedAt - Datetime
|
|
viewCounts - AnalyticsStoryViewCount
|
Reads a single AnalyticsStoryViewCount that is related to this CollectionsV2. |
visibility - String
|
|
Example
{
"aiData": [CollectionsAi],
"author": User,
"blocks": [BlockResource],
"canonicalName": "abc123",
"cardNarrations": [CardNarration],
"cardViews": [ReportCardView],
"childStoryViews": [ReportStoryView],
"commentCounts": StoryCommentsCount,
"comments": [StoryComment],
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"editors": [StoryGrant],
"hasViewed": true,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"isPublic": false,
"latestStoryState": Story,
"members": [CollectionMemberV2],
"name": "xyz789",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"playbackMedia": StoryPlaybackMedia,
"presentation": "xyz789",
"publishStatus": StoryPublishStatus,
"reportAllAnonStorySessionsOverTimesByStoryId": [
ReportAllAnonStorySessionsOverTime
],
"reportAllAnonStoryViewersOverTimesByStoryId": [
ReportAllAnonStoryViewersOverTime
],
"reportAllAnonUserStorySessionsOverTimesByStoryId": [
ReportAllAnonUserStorySessionsOverTime
],
"reportAllMemberStorySessionsOverTimesByStoryId": [
ReportAllMemberStorySessionsOverTime
],
"reportAllMemberStoryViewersOverTimesByStoryId": [
ReportAllMemberStoryViewersOverTime
],
"reportAllUserStorySessionsOverTimesByStoryId": [
ReportAllUserStorySessionsOverTime
],
"reportAvgViewsPerCardOverTimeForAnonUsersByStoryId": [
ReportAvgViewsPerCardOverTimeForAnonUser
],
"reportAvgViewsPerCardOverTimeForUsersByStoryId": [
ReportAvgViewsPerCardOverTimeForUser
],
"reportAvgViewsPerCardOverTimesByStoryId": [
ReportAvgViewsPerCardOverTime
],
"reportCardViewsListDuringTimePeriodsByStoryId": [
ReportCardViewsListDuringTimePeriod
],
"reportNumCardsViewedPerStoryForTimePeriodForAnonUsersByStoryId": [
ReportNumCardsViewedPerStoryForTimePeriodForAnonUser
],
"reportNumCardsViewedPerStoryForTimePeriodForUsersByStoryId": [
ReportNumCardsViewedPerStoryForTimePeriodForUser
],
"reportNumCardsViewedPerStoryForTimePeriodsByStoryId": [
ReportNumCardsViewedPerStoryForTimePeriod
],
"reportSessionsListDuringTimePeriodV2SByStoryId": [
ReportSessionsListDuringTimePeriodV2
],
"reportStoryAllAnonViewersByStoryId": [
ReportStoryAllAnonViewer
],
"reportStoryAllAnonViewersTotalsByStoryId": [
ReportStoryAllAnonViewersTotal
],
"reportStoryAllMemberViewersByStoryId": [
ReportStoryAllMemberViewer
],
"reportStoryAllMemberViewersTotalsByStoryId": [
ReportStoryAllMemberViewersTotal
],
"reportStoryAllViewersByStoryId": [
ReportStoryAllViewer
],
"reportStoryAllViewersV2SByStoryId": [
ReportStoryAllViewersV2
],
"reportTotalAnonStorySessionsDuringTimePeriodsByStoryId": [
ReportTotalAnonStorySessionsDuringTimePeriod
],
"reportTotalAnonStoryViewersDuringTimePeriodsByStoryId": [
ReportTotalAnonStoryViewersDuringTimePeriod
],
"reportTotalAnonUserStorySessionsDuringTimePeriodsByStoryId": [
ReportTotalAnonUserStorySessionsDuringTimePeriod
],
"reportTotalMemberStorySessionsDuringTimePeriodsByStoryId": [
ReportTotalMemberStorySessionsDuringTimePeriod
],
"reportTotalMemberStoryViewersDuringTimePeriodsByStoryId": [
ReportTotalMemberStoryViewersDuringTimePeriod
],
"reportTotalUserStorySessionsDuringTimePeriodsByStoryId": [
ReportTotalUserStorySessionsDuringTimePeriod
],
"reportUserCardViewsListDuringTimePeriodsByStoryId": [
ReportUserCardViewsListDuringTimePeriod
],
"reportViewersListDuringTimePeriodsByStoryId": [
ReportViewersListDuringTimePeriod
],
"sharedWith": [StoryGrant],
"spaceResourcesByStoryId": [SpaceResource],
"storyPreference": StoryPreference,
"storyPreferences": StoryPreference,
"storyPublishCounts": StoryPublishCount,
"storyPublishes": [StoryPublish],
"storyViewers": [AnalyticsStoryViewer],
"storyViews": [ReportStoryView],
"tags": [Tag],
"updatedAt": Datetime,
"viewCounts": AnalyticsStoryViewCount,
"visibility": "xyz789"
}
Color
CreateAccountInput
CreateAccountResult
Example
{
"avatarMediaId": 4,
"createdAt": Datetime,
"createdBy": 4,
"id": 4,
"isDeleted": true,
"name": "abc123",
"organizationId": "4",
"ownedBy": 4,
"updatedAt": Datetime,
"website": "abc123"
}
CreateMemoryEntryForAccountInput
CreateMemoryEntryForSpaceInput
CreateSpaceInput
Example
{
"accentColor": "abc123",
"audienceLogo": "4",
"audienceName": "abc123",
"description": "abc123",
"metadata": {},
"name": "abc123",
"primaryColor": "abc123",
"thumbnailOverride": "4",
"workflowState": "abc123"
}
Datetime
Description
A point in time as described by the ISO 8601 standard. May or may not include a timezone.
Example
Datetime
EmailFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DIGEST"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GetOrganizationSpacesInput
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
sortDirection - SortDirection
|
Example
{"limit": 987, "offset": 987, "sortDirection": "ASC"}
GetViewerStoriesInput
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LibraryItem
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this LibraryItem. |
blocks - [BlockResource!]!
|
Reads and enables pagination through a set of BlockResource. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
deletedAt - Datetime
|
|
description - String
|
|
id - UUID!
|
|
media - Media
|
Reads a single Media that is related to this LibraryItem. |
mediaId - UUID
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this LibraryItem. |
organizationId - UUID
|
|
pageTimeSpent - [LibraryItemPageTimeSpentSummary!]!
|
Reads and enables pagination through a set of LibraryItemPageTimeSpentSummary. |
properties - JSON
|
|
spaceResources - [SpaceResource!]!
|
Reads and enables pagination through a set of SpaceResource. |
tags - [LibraryItemTag!]!
|
Reads and enables pagination through a set of LibraryItemTag. |
type - String
|
|
updatedAt - Datetime
|
|
viewerPageTimeSpent - [LibraryItemViewerPageTimeSpent!]!
|
Reads and enables pagination through a set of LibraryItemViewerPageTimeSpent. |
viewerTimeSpent - [LibraryItemViewerTimeSpent!]!
|
Reads and enables pagination through a set of LibraryItemViewerTimeSpent. |
Example
{
"author": User,
"blocks": [BlockResource],
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"name": "abc123",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"pageTimeSpent": [LibraryItemPageTimeSpentSummary],
"properties": {},
"spaceResources": [SpaceResource],
"tags": [LibraryItemTag],
"type": "xyz789",
"updatedAt": Datetime,
"viewerPageTimeSpent": [LibraryItemViewerPageTimeSpent],
"viewerTimeSpent": [LibraryItemViewerTimeSpent]
}
LibraryItemPageTimeSpentSummary
Fields
| Field Name | Description |
|---|---|
eventCount - BigInt
|
|
firstViewedAt - Datetime
|
|
lastViewedAt - Datetime
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this LibraryItemPageTimeSpentSummary. |
libraryItemId - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
pageNumber - Int!
|
|
totalTimeSeconds - BigInt
|
|
uniqueViewers - BigInt
|
Example
{
"eventCount": {},
"firstViewedAt": Datetime,
"lastViewedAt": Datetime,
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"pageNumber": 123,
"totalTimeSeconds": {},
"uniqueViewers": {}
}
LibraryItemTag
Fields
| Field Name | Description |
|---|---|
addedBy - UUID
|
|
addedByUser - User
|
Reads a single User that is related to this LibraryItemTag. |
createdAt - Datetime
|
|
id - UUID!
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this LibraryItemTag. |
libraryItemId - UUID
|
|
libraryTagId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this LibraryItemTag. |
organizationId - UUID
|
|
tag - LibraryTag
|
Reads a single LibraryTag that is related to this LibraryItemTag. |
Example
{
"addedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"addedByUser": User,
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryTagId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"tag": LibraryTag
}
LibraryItemViewerPageTimeSpent
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
firstViewedAt - Datetime
|
|
lastViewedAt - Datetime
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this LibraryItemViewerPageTimeSpent. |
libraryItemId - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
pageNumber - Int!
|
|
sessionCount - BigInt
|
|
totalTimeSeconds - BigInt
|
|
user - User
|
Reads a single User that is related to this LibraryItemViewerPageTimeSpent. |
userId - UUID
|
|
viewCount - BigInt
|
|
viewerId - String!
|
Example
{
"anonId": "abc123",
"firstViewedAt": Datetime,
"lastViewedAt": Datetime,
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"pageNumber": 987,
"sessionCount": {},
"totalTimeSeconds": {},
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewCount": {},
"viewerId": "xyz789"
}
LibraryItemViewerTimeSpent
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
firstViewedAt - Datetime
|
|
lastViewedAt - Datetime
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this LibraryItemViewerTimeSpent. |
libraryItemId - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
sessionCount - BigInt
|
|
totalEvents - BigInt
|
|
totalTimeSeconds - BigInt
|
|
uniquePagesViewed - BigInt
|
|
user - User
|
Reads a single User that is related to this LibraryItemViewerTimeSpent. |
userId - UUID
|
|
viewerId - String!
|
Example
{
"anonId": "xyz789",
"firstViewedAt": Datetime,
"lastViewedAt": Datetime,
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"sessionCount": {},
"totalEvents": {},
"totalTimeSeconds": {},
"uniquePagesViewed": {},
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewerId": "xyz789"
}
LibrarySearchInput
Example
{
"categories": ["xyz789"],
"filterBy": "abc123",
"filterValue": "abc123",
"limit": 987,
"offset": 987,
"query": "xyz789",
"requireAllCategories": true,
"sortBy": "abc123",
"sortOrder": "abc123",
"tagIds": [4]
}
LibrarySearchResult
Fields
| Field Name | Description |
|---|---|
createdBy - UUID
|
|
description - String
|
|
duration - Int
|
|
fileSize - Int
|
|
height - Int
|
|
id - UUID
|
|
libraryId - UUID
|
|
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this LibrarySearchResult. |
meta - JSON
|
|
name - String
|
|
organizationId - UUID
|
|
relevance - String
|
|
updatedAt - Datetime
|
|
width - Int
|
Example
{
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"duration": 987,
"fileSize": 987,
"height": 123,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryItem": LibraryItem,
"meta": {},
"name": "xyz789",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"relevance": "abc123",
"updatedAt": Datetime,
"width": 987
}
LibraryTag
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this LibraryTag. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
items - [LibraryItemTag!]!
|
Reads and enables pagination through a set of LibraryItemTag. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this LibraryTag. |
organizationId - UUID
|
|
source - LibraryTagSource
|
|
updatedAt - Datetime
|
|
visibility - LibraryTagVisibility
|
|
Example
{
"author": User,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"items": [LibraryItemTag],
"name": "abc123",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"source": "AI",
"updatedAt": Datetime,
"visibility": "HIDDEN"
}
LibraryTagSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AI"
LibraryTagVisibility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HIDDEN"
Logo
Logos
Media
Fields
| Field Name | Description |
|---|---|
accountAvatars - [Account!]!
|
Reads and enables pagination through a set of Account. |
alt - String
|
|
boards - [BoardPreviewImage!]!
|
Reads and enables pagination through a set of BoardPreviewImage. |
cardMediaRelationsByPrimaryMediaIdAndOrganizationId - [CardMediaRelation!]!
|
Reads and enables pagination through a set of CardMediaRelation. |
cardMediaRelationsBySecondaryMediaIdAndOrganizationId - [CardMediaRelation!]!
|
Reads and enables pagination through a set of CardMediaRelation. |
cardPlaybackMedias - [CardPlaybackMedia!]!
|
Reads and enables pagination through a set of CardPlaybackMedia. |
cardsByPreviewMediaId - [Card!]!
|
Reads and enables pagination through a set of Card. |
createdAt - Datetime
|
|
derivedFromId - UUID
|
|
generations - [MediaGeneration!]!
|
Reads and enables pagination through a set of MediaGeneration. |
hasPendingSources - Boolean!
|
|
id - UUID!
|
|
libraryItems - [LibraryItem!]!
|
Reads and enables pagination through a set of LibraryItem. |
mediaActionPlanItemResponses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
meta - MediaMeta!
|
|
metadata - JSON
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
sources - [MediaSource!]!
|
Reads and enables pagination through a set of MediaSource. |
spaceLogos - [Space!]!
|
Reads and enables pagination through a set of Space. |
stories - [Story!]!
|
Reads and enables pagination through a set of Story. |
storyPlaybackMedias - [StoryPlaybackMedia!]!
|
Reads and enables pagination through a set of StoryPlaybackMedia. |
storyPreferences - [StoryPreference!]!
|
Reads and enables pagination through a set of StoryPreference. |
tracks - [MediaTimingTrack!]!
|
Reads and enables pagination through a set of MediaTimingTrack. |
transcript - [Transcript!]!
|
Reads and enables pagination through a set of Transcript. |
updatedAt - Datetime
|
|
userProfilesV2SByAvatarMediaId - [UserProfilesV2!]!
|
Reads and enables pagination through a set of UserProfilesV2. |
usersByAvatarMediaId - [User!]!
|
Reads and enables pagination through a set of User. |
Example
{
"accountAvatars": [Account],
"alt": "xyz789",
"boards": [BoardPreviewImage],
"cardMediaRelationsByPrimaryMediaIdAndOrganizationId": [
CardMediaRelation
],
"cardMediaRelationsBySecondaryMediaIdAndOrganizationId": [
CardMediaRelation
],
"cardPlaybackMedias": [CardPlaybackMedia],
"cardsByPreviewMediaId": [Card],
"createdAt": Datetime,
"derivedFromId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"generations": [MediaGeneration],
"hasPendingSources": true,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"libraryItems": [LibraryItem],
"mediaActionPlanItemResponses": [
ActionPlanItemResponse
],
"meta": MediaMeta,
"metadata": {},
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"sources": [MediaSource],
"spaceLogos": [Space],
"stories": [Story],
"storyPlaybackMedias": [StoryPlaybackMedia],
"storyPreferences": [StoryPreference],
"tracks": [MediaTimingTrack],
"transcript": [Transcript],
"updatedAt": Datetime,
"userProfilesV2SByAvatarMediaId": [UserProfilesV2],
"usersByAvatarMediaId": [User]
}
MediaGeneration
Fields
| Field Name | Description |
|---|---|
completedAt - Datetime
|
|
createdAt - Datetime
|
|
id - UUID!
|
|
media - Media
|
Reads a single Media that is related to this MediaGeneration. |
mediaId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
stage - String
|
Example
{
"completedAt": Datetime,
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"stage": "abc123"
}
MediaMeta
Fields
| Field Name | Description |
|---|---|
trim - MediaTrimMeta
|
Example
{"trim": MediaTrimMeta}
MediaSource
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
mediaId - UUID
|
|
metadata - JSON
|
|
mimeType - String
|
|
muxPlaybackId - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
parent - Media
|
Reads a single Media that is related to this MediaSource. |
sourceType - String
|
|
src - String!
|
|
storageKey - String
|
|
transcript - Transcript
|
Reads a single Transcript that is related to this MediaSource. |
updatedAt - Datetime
|
|
uploadedAt - Datetime
|
Example
{
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"mimeType": "xyz789",
"muxPlaybackId": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"parent": Media,
"sourceType": "abc123",
"src": "abc123",
"storageKey": "xyz789",
"transcript": Transcript,
"updatedAt": Datetime,
"uploadedAt": Datetime
}
MediaTimingTrack
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
createdBy - UUID
|
|
data - JSON
|
|
id - UUID!
|
|
media - Media
|
Reads a single Media that is related to this MediaTimingTrack. |
mediaId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
type - String
|
Example
{
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"data": {},
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"type": "xyz789"
}
MediaTrimMeta
Fields
| Field Name | Description |
|---|---|
clipBounds - [MeidaTrimClip!]!
|
|
playbackBounds - [MeidaTrimClip!]
|
|
state - MediaTrimState!
|
Example
{
"clipBounds": [MeidaTrimClip],
"playbackBounds": [MeidaTrimClip],
"state": "COMPLETED"
}
MediaTrimState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
MeidaTrimClip
MemoryEntry
Fields
| Field Name | Description |
|---|---|
accountMemoryEntries - [AccountMemoryEntry!]!
|
Reads and enables pagination through a set of AccountMemoryEntry. |
content - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
embedding - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this MemoryEntry. |
organizationId - UUID
|
|
organizationMemoryEntries - [OrganizationMemoryEntry!]!
|
Reads and enables pagination through a set of OrganizationMemoryEntry. |
spaceMemoryEntries - [SpaceMemoryEntry!]!
|
Reads and enables pagination through a set of SpaceMemoryEntry. |
updatedAt - Datetime
|
|
updatedBy - UUID
|
|
Example
{
"accountMemoryEntries": [AccountMemoryEntry],
"content": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"embedding": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationMemoryEntries": [OrganizationMemoryEntry],
"spaceMemoryEntries": [SpaceMemoryEntry],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
Metric
Example
{
"createdAt": Datetime,
"entityId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"meta": {},
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"type": "BOARD_VIEW",
"updatedAt": Datetime,
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
MetricType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BOARD_VIEW"
Organization
Fields
| Field Name | Description |
|---|---|
accounts - [Account!]!
|
|
actionPlans - [ActionPlan!]!
|
Reads and enables pagination through a set of ActionPlan. |
authProviderId - String
|
|
collectionsAi - [CollectionsAi!]!
|
Reads and enables pagination through a set of CollectionsAi. |
collectionsV2 - [CollectionsV2!]!
|
Reads and enables pagination through a set of CollectionsV2. |
createdAt - Datetime
|
|
defaultBrandKit - BrandKit
|
|
displayName - String
|
|
domain - String
|
|
id - UUID
|
|
isChurning - Boolean
|
|
libraryItemTags - [LibraryItemTag!]!
|
Reads and enables pagination through a set of LibraryItemTag. |
libraryItems - [LibraryItem!]!
|
Reads and enables pagination through a set of LibraryItem. |
libraryTags - [LibraryTag!]!
|
Reads and enables pagination through a set of LibraryTag. |
members - [User!]
|
|
memoryEntries - [MemoryEntry!]!
|
Reads and enables pagination through a set of MemoryEntry. |
name - String
|
|
organizationMemoryEntries - [OrganizationMemoryEntry!]!
|
Reads and enables pagination through a set of OrganizationMemoryEntry. |
ownedBy - UUID
|
|
preferences - JSON
|
|
productRole - String
|
|
provisionedSeats - BigInt
|
|
spaceTemplates - [SpaceTemplate!]!
|
Reads and enables pagination through a set of SpaceTemplate. |
spaces - [Space!]!
|
Reads and enables pagination through a set of Space. |
stats - [OrganizationStat!]!
|
Reads and enables pagination through a set of OrganizationStat. |
storyPublishes - [StoryPublish!]!
|
Reads and enables pagination through a set of StoryPublish. |
stripeCustomerId - String
|
|
stripeSubscriptionId - String
|
|
turnstilePolicies - [TurnstilePolicy!]!
|
Reads and enables pagination through a set of TurnstilePolicy. |
updatedAt - Datetime
|
|
Example
{
"accounts": [Account],
"actionPlans": [ActionPlan],
"authProviderId": "xyz789",
"collectionsAi": [CollectionsAi],
"collectionsV2": [CollectionsV2],
"createdAt": Datetime,
"defaultBrandKit": BrandKit,
"displayName": "abc123",
"domain": "xyz789",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isChurning": true,
"libraryItemTags": [LibraryItemTag],
"libraryItems": [LibraryItem],
"libraryTags": [LibraryTag],
"members": [User],
"memoryEntries": [MemoryEntry],
"name": "abc123",
"organizationMemoryEntries": [OrganizationMemoryEntry],
"ownedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"preferences": {},
"productRole": "abc123",
"provisionedSeats": {},
"spaceTemplates": [SpaceTemplate],
"spaces": [Space],
"stats": [OrganizationStat],
"storyPublishes": [StoryPublish],
"stripeCustomerId": "abc123",
"stripeSubscriptionId": "abc123",
"turnstilePolicies": [TurnstilePolicy],
"updatedAt": Datetime
}
OrganizationMemoryEntry
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
id - UUID!
|
|
memoryEntry - MemoryEntry
|
Reads a single MemoryEntry that is related to this OrganizationMemoryEntry. |
memoryEntryId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this OrganizationMemoryEntry. |
organizationId - UUID
|
Example
{
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memoryEntry": MemoryEntry,
"memoryEntryId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
OrganizationStat
Fields
| Field Name | Description |
|---|---|
boardcount - BigInt
|
|
organization - Organization
|
Reads a single Organization that is related to this OrganizationStat. |
organizationId - UUID
|
|
storycount - BigInt
|
|
usercount - BigInt
|
Example
{
"boardcount": {},
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"storycount": {},
"usercount": {}
}
ParticipantProfile
Fields
| Field Name | Description |
|---|---|
assignedActionItems - [ActionPlanItem!]!
|
Reads and enables pagination through a set of ActionPlanItem. |
company - String
|
|
createdAt - Datetime
|
|
email - String
|
|
id - UUID
|
|
legal - JSON
|
|
metadata - JSON
|
|
name - String
|
|
notes - String
|
|
organizationId - UUID
|
|
responses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
spaceActivityEvents - [SpaceActivityEvent!]!
|
Reads and enables pagination through a set of SpaceActivityEvent. |
spaceExternalParticipants - [SpaceExternalParticipant!]!
|
Reads and enables pagination through a set of SpaceExternalParticipant. |
spaceParticipantSessionTotals - [ReportSpaceParticipantSessionTotal!]!
|
Reads and enables pagination through a set of ReportSpaceParticipantSessionTotal. |
spaceParticipants - [SpaceParticipant!]!
|
Reads and enables pagination through a set of SpaceParticipant. |
spaceSessionDurations - [ReportSpaceSessionDuration!]!
|
Reads and enables pagination through a set of ReportSpaceSessionDuration. |
title - String
|
|
turnstileCompletions - [TurnstileCompletion!]!
|
Reads and enables pagination through a set of TurnstileCompletion. |
updatedAt - Datetime
|
|
Example
{
"assignedActionItems": [ActionPlanItem],
"company": "abc123",
"createdAt": Datetime,
"email": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"legal": {},
"metadata": {},
"name": "xyz789",
"notes": "abc123",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"responses": [ActionPlanItemResponse],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceExternalParticipants": [SpaceExternalParticipant],
"spaceParticipantSessionTotals": [
ReportSpaceParticipantSessionTotal
],
"spaceParticipants": [SpaceParticipant],
"spaceSessionDurations": [ReportSpaceSessionDuration],
"title": "abc123",
"turnstileCompletions": [TurnstileCompletion],
"updatedAt": Datetime
}
Reaction
Fields
| Field Name | Description |
|---|---|
cards - Card
|
Reads a single Card that is related to this Reaction. |
createdAt - Datetime!
|
|
entityId - UUID!
|
|
id - UUID!
|
|
metadata - JSON!
|
|
organizationId - UUID!
|
|
reactionType - ReactionType
|
Reads a single ReactionType that is related to this Reaction. |
reactionTypeId - UUID!
|
|
storyComments - StoryComment
|
Reads a single StoryComment that is related to this Reaction. |
userId - UUID!
|
Example
{
"cards": Card,
"createdAt": Datetime,
"entityId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"reactionType": ReactionType,
"reactionTypeId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"storyComments": StoryComment,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReactionType
Example
{
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"imageUri": "xyz789",
"name": "abc123",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"reactions": [Reaction],
"tag": "abc123",
"updatedAt": Datetime
}
ReportAllAnonStorySessionsOverTime
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllAnonStorySessionsOverTime. |
date - Datetime
|
|
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"collection": CollectionsV2,
"date": Datetime,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportAllAnonStoryViewersOverTime
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllAnonStoryViewersOverTime. |
date - Datetime
|
|
storyId - UUID
|
|
viewers - BigInt
|
Example
{
"collection": CollectionsV2,
"date": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewers": {}
}
ReportAllAnonUserStorySessionsOverTime
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllAnonUserStorySessionsOverTime. |
date - Datetime
|
|
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"anonId": "xyz789",
"collection": CollectionsV2,
"date": Datetime,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportAllMemberStorySessionsOverTime
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllMemberStorySessionsOverTime. |
date - Datetime
|
|
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"collection": CollectionsV2,
"date": Datetime,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportAllMemberStoryViewersOverTime
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllMemberStoryViewersOverTime. |
date - Datetime
|
|
storyId - UUID
|
|
viewers - BigInt
|
Example
{
"collection": CollectionsV2,
"date": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewers": {}
}
ReportAllUserStorySessionsOverTime
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAllUserStorySessionsOverTime. |
date - Datetime
|
|
sessions - BigInt
|
|
storyId - UUID
|
|
userId - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportAllUserStorySessionsOverTime. |
Example
{
"collection": CollectionsV2,
"date": Datetime,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportAvgViewsPerCardOverTime
Example
{
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"cards": Card,
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"timeSpent": BigFloat,
"views": {}
}
ReportAvgViewsPerCardOverTimeForAnonUser
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
anonymousName - JSON
|
|
cardId - UUID
|
|
cards - Card
|
Reads a single Card that is related to this ReportAvgViewsPerCardOverTimeForAnonUser. |
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAvgViewsPerCardOverTimeForAnonUser. |
storyId - UUID
|
|
timeSpent - BigFloat
|
|
views - BigInt
|
Example
{
"anonId": "xyz789",
"anonymousName": {},
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"cards": Card,
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"timeSpent": BigFloat,
"views": {}
}
ReportAvgViewsPerCardOverTimeForUser
Fields
| Field Name | Description |
|---|---|
cardId - UUID
|
|
cards - Card
|
Reads a single Card that is related to this ReportAvgViewsPerCardOverTimeForUser. |
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportAvgViewsPerCardOverTimeForUser. |
storyId - UUID
|
|
timeSpent - BigFloat
|
|
userId - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportAvgViewsPerCardOverTimeForUser. |
views - BigInt
|
Example
{
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"cards": Card,
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"timeSpent": BigFloat,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User,
"views": {}
}
ReportCardView
Fields
| Field Name | Description |
|---|---|
cardId - UUID
|
|
cards - Card
|
Reads a single Card that is related to this ReportCardView. |
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportCardView. |
organizationId - UUID
|
|
parentCollectionId - UUID
|
|
user - User
|
Reads a single User that is related to this ReportCardView. |
viewedAt - Datetime
|
|
viewedBy - UUID
|
|
views - BigInt
|
Example
{
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"cards": Card,
"collection": CollectionsV2,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"parentCollectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"viewedAt": Datetime,
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"views": {}
}
ReportCardViewsListDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
card - Card
|
Reads a single Card that is related to this ReportCardViewsListDuringTimePeriod. |
cardId - UUID
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportCardViewsListDuringTimePeriod. |
storyId - UUID
|
|
viewedBy - UUID
|
|
views - BigInt
|
Example
{
"anonymouslyViewedBy": "abc123",
"card": Card,
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"views": {}
}
ReportNumCardsViewedPerStoryForTimePeriod
Fields
| Field Name | Description |
|---|---|
cardsViewed - BigInt
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportNumCardsViewedPerStoryForTimePeriod. |
storyId - UUID
|
Example
{
"cardsViewed": {},
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportNumCardsViewedPerStoryForTimePeriodForAnonUser
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
cardsViewed - BigInt
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportNumCardsViewedPerStoryForTimePeriodForAnonUser. |
storyId - UUID
|
Example
{
"anonId": "abc123",
"cardsViewed": {},
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportNumCardsViewedPerStoryForTimePeriodForUser
Fields
| Field Name | Description |
|---|---|
cardsViewed - BigInt
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportNumCardsViewedPerStoryForTimePeriodForUser. |
storyId - UUID
|
|
userId - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportNumCardsViewedPerStoryForTimePeriodForUser. |
Example
{
"cardsViewed": {},
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportSessionsListDuringTimePeriodV2
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
cardsViewed - BigInt
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportSessionsListDuringTimePeriodV2. |
device - JSON
|
|
sessionCreatedAt - Datetime
|
|
sessionDuration - BigFloat
|
|
sessionId - String
|
|
storyId - UUID
|
|
user - User
|
Reads a single User that is related to this ReportSessionsListDuringTimePeriodV2. |
viewedBy - UUID
|
Example
{
"anonymouslyViewedBy": "xyz789",
"cardsViewed": {},
"collection": CollectionsV2,
"device": {},
"sessionCreatedAt": Datetime,
"sessionDuration": BigFloat,
"sessionId": "abc123",
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportSpaceParticipantMetric
Fields
| Field Name | Description |
|---|---|
avgParticipantAvgSessionDurationMs - BigFloat
|
|
avgParticipantTotalDurationMs - BigFloat
|
|
avgSessionsPerParticipant - BigFloat
|
|
maxParticipantTotalDurationMs - BigFloat
|
|
minParticipantTotalDurationMs - BigFloat
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
space - Space
|
Reads a single Space that is related to this ReportSpaceParticipantMetric. |
spaceId - UUID!
|
|
totalParticipants - BigInt
|
Example
{
"avgParticipantAvgSessionDurationMs": BigFloat,
"avgParticipantTotalDurationMs": BigFloat,
"avgSessionsPerParticipant": BigFloat,
"maxParticipantTotalDurationMs": BigFloat,
"minParticipantTotalDurationMs": BigFloat,
"nodeId": "4",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalParticipants": {}
}
ReportSpaceParticipantSessionTotal
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
avgDurationMs - BigFloat
|
|
firstSessionAt - Datetime
|
|
lastSessionAt - Datetime
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
participantId - String!
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this ReportSpaceParticipantSessionTotal. |
participantProfileId - UUID
|
|
space - Space
|
Reads a single Space that is related to this ReportSpaceParticipantSessionTotal. |
spaceId - UUID!
|
|
totalDurationMs - BigFloat
|
|
totalSessions - BigInt
|
Example
{
"anonId": "xyz789",
"avgDurationMs": BigFloat,
"firstSessionAt": Datetime,
"lastSessionAt": Datetime,
"nodeId": "4",
"participantId": "xyz789",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalDurationMs": BigFloat,
"totalSessions": {}
}
ReportSpaceSessionDuration
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
createdAt - Datetime
|
|
data - JSON
|
|
durationMs - BigInt
|
|
entityOrganizationId - UUID
|
|
id - UUID!
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this ReportSpaceSessionDuration. |
participantProfileId - UUID
|
|
sessionCreatedAt - Datetime
|
|
sessionExpiresAt - Datetime
|
|
sessionId - String
|
|
space - Space
|
Reads a single Space that is related to this ReportSpaceSessionDuration. |
spaceId - UUID
|
|
userId - UUID
|
Example
{
"anonId": "abc123",
"createdAt": Datetime,
"data": {},
"durationMs": {},
"entityOrganizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"name": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"sessionCreatedAt": Datetime,
"sessionExpiresAt": Datetime,
"sessionId": "xyz789",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportSpaceSessionStatistic
Fields
| Field Name | Description |
|---|---|
anonymousParticipants - BigInt
|
|
avgSessionDurationMs - BigFloat
|
|
identifiedParticipants - BigInt
|
|
maxSessionDurationMs - BigInt
|
|
minSessionDurationMs - BigInt
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
space - Space
|
Reads a single Space that is related to this ReportSpaceSessionStatistic. |
spaceId - UUID!
|
|
totalDurationMs - BigFloat
|
|
totalParticipants - BigInt
|
|
totalSessionsWithDuration - BigInt
|
Example
{
"anonymousParticipants": {},
"avgSessionDurationMs": BigFloat,
"identifiedParticipants": {},
"maxSessionDurationMs": {},
"minSessionDurationMs": {},
"nodeId": 4,
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalDurationMs": BigFloat,
"totalParticipants": {},
"totalSessionsWithDuration": {}
}
ReportStoryAllAnonViewer
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryAllAnonViewer. |
lastViewed - Datetime
|
|
storyId - UUID
|
|
total - BigInt
|
|
viewedBy - String
|
Example
{
"collection": CollectionsV2,
"lastViewed": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {},
"viewedBy": "abc123"
}
ReportStoryAllAnonViewersTotal
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryAllAnonViewersTotal. |
storyId - UUID
|
|
total - BigInt
|
Example
{
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {}
}
ReportStoryAllMemberViewer
Example
{
"collection": CollectionsV2,
"lastViewed": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {},
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportStoryAllMemberViewersTotal
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryAllMemberViewersTotal. |
storyId - UUID
|
|
total - BigInt
|
Example
{
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {}
}
ReportStoryAllViewer
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryAllViewer. |
lastViewed - Datetime
|
|
storyId - UUID
|
|
total - BigInt
|
|
viewedBy - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportStoryAllViewer. |
Example
{
"anonymouslyViewedBy": "abc123",
"collection": CollectionsV2,
"lastViewed": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {},
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportStoryAllViewersV2
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryAllViewersV2. |
lastViewed - Datetime
|
|
storyId - UUID
|
|
total - BigInt
|
|
viewedBy - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportStoryAllViewersV2. |
Example
{
"anonymouslyViewedBy": "xyz789",
"collection": CollectionsV2,
"lastViewed": Datetime,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"total": {},
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportStoryView
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryView. |
collectionId - UUID
|
|
organizationId - UUID
|
|
parentCollection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportStoryView. |
parentCollectionId - UUID
|
|
user - User
|
Reads a single User that is related to this ReportStoryView. |
viewedAt - Datetime
|
|
viewedBy - UUID
|
|
views - BigInt
|
Example
{
"collection": CollectionsV2,
"collectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"parentCollection": CollectionsV2,
"parentCollectionId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"viewedAt": Datetime,
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"views": {}
}
ReportTotalAnonStorySessionsDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalAnonStorySessionsDuringTimePeriod. |
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"collection": CollectionsV2,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportTotalAnonStoryViewersDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalAnonStoryViewersDuringTimePeriod. |
storyId - UUID
|
|
viewers - BigInt
|
Example
{
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewers": {}
}
ReportTotalAnonUserStorySessionsDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
anonId - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalAnonUserStorySessionsDuringTimePeriod. |
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"anonId": "xyz789",
"collection": CollectionsV2,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportTotalMemberStorySessionsDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalMemberStorySessionsDuringTimePeriod. |
sessions - BigInt
|
|
storyId - UUID
|
Example
{
"collection": CollectionsV2,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
ReportTotalMemberStoryViewersDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalMemberStoryViewersDuringTimePeriod. |
storyId - UUID
|
|
viewers - BigInt
|
Example
{
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewers": {}
}
ReportTotalUserStorySessionsDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportTotalUserStorySessionsDuringTimePeriod. |
sessions - BigInt
|
|
storyId - UUID
|
|
userId - UUID
|
|
viewer - User
|
Reads a single User that is related to this ReportTotalUserStorySessionsDuringTimePeriod. |
Example
{
"collection": CollectionsV2,
"sessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"viewer": User
}
ReportUserCardViewsListDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
card - Card
|
Reads a single Card that is related to this ReportUserCardViewsListDuringTimePeriod. |
cardId - UUID
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportUserCardViewsListDuringTimePeriod. |
storyId - UUID
|
|
user - User
|
Reads a single User that is related to this ReportUserCardViewsListDuringTimePeriod. |
viewedBy - UUID
|
|
views - BigInt
|
Example
{
"anonymouslyViewedBy": "xyz789",
"card": Card,
"cardId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"collection": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"views": {}
}
ReportViewersListDuringTimePeriod
Fields
| Field Name | Description |
|---|---|
anonymouslyViewedBy - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this ReportViewersListDuringTimePeriod. |
lastViewed - Datetime
|
|
numSessions - BigInt
|
|
storyId - UUID
|
|
totalTime - BigFloat
|
|
user - User
|
Reads a single User that is related to this ReportViewersListDuringTimePeriod. |
viewedBy - UUID
|
Example
{
"anonymouslyViewedBy": "abc123",
"collection": CollectionsV2,
"lastViewed": Datetime,
"numSessions": {},
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalTime": BigFloat,
"user": User,
"viewedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
Section
Fields
| Field Name | Description |
|---|---|
canonicalName - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
isPublic - Boolean
|
|
memberOf - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
members - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
presentation - String
|
|
updatedAt - Datetime
|
|
Example
{
"canonicalName": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"isPublic": false,
"memberOf": [CollectionMemberV2],
"members": [CollectionMemberV2],
"name": "xyz789",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"presentation": "abc123",
"updatedAt": Datetime
}
SiteTheme
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DARK"
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
Space
Fields
| Field Name | Description |
|---|---|
accentColor - String
|
|
accessPolicy - String
|
|
accounts - [AccountSpace!]!
|
Reads and enables pagination through a set of AccountSpace. |
actionPlan - [ActionPlan!]!
|
Reads and enables pagination through a set of ActionPlan. |
audienceLogo - UUID
|
|
audienceLogoMedia - Media
|
Reads a single Media that is related to this Space. 2025-08-15 Use audienceThumbnail instead
|
audienceName - String
|
|
audienceThumbnail - Media
|
|
author - User
|
Reads a single User that is related to this Space. |
bannerImage - UUID
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
deletedAt - Datetime
|
|
description - String
|
|
externalParticipants - [SpaceExternalParticipant!]!
|
Reads and enables pagination through a set of SpaceExternalParticipant. |
id - UUID!
|
|
internalParticipants - [SpaceInternalParticipant!]!
|
Reads and enables pagination through a set of SpaceInternalParticipant. |
isTemplateEphemeral - Boolean
|
|
metadata - JSON
|
|
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this Space. |
organizationId - UUID
|
|
passwordRequired - Boolean
|
|
passwords - [SpacePassword!]!
|
Reads and enables pagination through a set of SpacePassword. |
pointOfContact - User
|
Reads a single User that is related to this Space. |
pointOfContactId - UUID
|
|
primaryColor - String
|
|
resources - [SpaceResource!]!
|
Reads and enables pagination through a set of SpaceResource. |
spaceActionPlanItemResponses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
spaceActivityEvents - [SpaceActivityEvent!]!
|
Reads and enables pagination through a set of SpaceActivityEvent. |
spaceBlocks - [SpaceBlock!]!
|
Reads and enables pagination through a set of SpaceBlock. |
spaceMemoryEntries - [SpaceMemoryEntry!]!
|
Reads and enables pagination through a set of SpaceMemoryEntry. |
spaceParticipantMetrics - ReportSpaceParticipantMetric
|
Reads a single ReportSpaceParticipantMetric that is related to this Space. |
spaceParticipantSessionTotals - [ReportSpaceParticipantSessionTotal!]!
|
Reads and enables pagination through a set of ReportSpaceParticipantSessionTotal. |
spaceParticipants - [SpaceParticipant!]!
|
Reads and enables pagination through a set of SpaceParticipant. |
spaceSessionDurations - [ReportSpaceSessionDuration!]!
|
Reads and enables pagination through a set of ReportSpaceSessionDuration. |
spaceSessionStatistics - ReportSpaceSessionStatistic
|
Reads a single ReportSpaceSessionStatistic that is related to this Space. |
template - SpaceTemplate
|
Reads a single SpaceTemplate that is related to this Space. |
templateId - UUID
|
|
thumbnailOverride - UUID
|
|
updatedAt - Datetime
|
|
workflowState - String
|
|
Example
{
"accentColor": "abc123",
"accessPolicy": "xyz789",
"accounts": [AccountSpace],
"actionPlan": [ActionPlan],
"audienceLogo": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"audienceLogoMedia": Media,
"audienceName": "xyz789",
"audienceThumbnail": Media,
"author": User,
"bannerImage": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"deletedAt": Datetime,
"description": "abc123",
"externalParticipants": [SpaceExternalParticipant],
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"internalParticipants": [SpaceInternalParticipant],
"isTemplateEphemeral": true,
"metadata": {},
"name": "xyz789",
"nodeId": 4,
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"passwordRequired": false,
"passwords": [SpacePassword],
"pointOfContact": User,
"pointOfContactId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"primaryColor": "xyz789",
"resources": [SpaceResource],
"spaceActionPlanItemResponses": [
ActionPlanItemResponse
],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceBlocks": [SpaceBlock],
"spaceMemoryEntries": [SpaceMemoryEntry],
"spaceParticipantMetrics": ReportSpaceParticipantMetric,
"spaceParticipantSessionTotals": [
ReportSpaceParticipantSessionTotal
],
"spaceParticipants": [SpaceParticipant],
"spaceSessionDurations": [ReportSpaceSessionDuration],
"spaceSessionStatistics": ReportSpaceSessionStatistic,
"template": SpaceTemplate,
"templateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"thumbnailOverride": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"workflowState": "abc123"
}
SpaceActivityEvent
Fields
| Field Name | Description |
|---|---|
anonymousId - String
|
|
block - Block
|
Reads a single Block that is related to this SpaceActivityEvent. |
blockId - UUID
|
|
createdAt - Datetime
|
|
data - JSON
|
|
eventName - String
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
participantEmail - String
|
|
participantName - String
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this SpaceActivityEvent. |
participantProfileId - UUID
|
|
space - Space
|
Reads a single Space that is related to this SpaceActivityEvent. |
spaceId - UUID
|
|
user - User
|
Reads a single User that is related to this SpaceActivityEvent. |
userId - UUID
|
Example
{
"anonymousId": "abc123",
"block": Block,
"blockId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"createdAt": Datetime,
"data": {},
"eventName": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"participantEmail": "abc123",
"participantName": "xyz789",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
SpaceBlock
Fields
| Field Name | Description |
|---|---|
block - Block
|
Reads a single Block that is related to this SpaceBlock. |
blockId - UUID
|
|
blockName - String
|
|
blockType - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
position - Int
|
|
props - JSON
|
|
space - Space
|
Reads a single Space that is related to this SpaceBlock. |
spaceId - UUID
|
|
updatedAt - Datetime
|
|
visibility - String
|
Example
{
"block": Block,
"blockId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"blockName": "abc123",
"blockType": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"position": 123,
"props": {},
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"visibility": "abc123"
}
SpaceExternalParticipant
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
createdBy - UUID
|
|
id - UUID
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this SpaceExternalParticipant. |
participantProfileId - UUID
|
|
space - Space
|
Reads a single Space that is related to this SpaceExternalParticipant. |
spaceId - UUID
|
|
updatedAt - Datetime
|
Example
{
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime
}
SpaceInternalParticipant
Example
{
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"updatedAt": Datetime,
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
SpaceMemoryEntry
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
id - UUID!
|
|
memoryEntry - MemoryEntry
|
Reads a single MemoryEntry that is related to this SpaceMemoryEntry. |
memoryEntryId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
space - Space
|
Reads a single Space that is related to this SpaceMemoryEntry. |
spaceId - UUID
|
Example
{
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"memoryEntry": MemoryEntry,
"memoryEntryId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
SpaceParticipant
Fields
| Field Name | Description |
|---|---|
anonymousId - String
|
|
email - String
|
|
firstVisitedAt - Datetime
|
|
isAnonymous - Boolean
|
|
lastVisitedAt - Datetime
|
|
name - String
|
|
organizationId - UUID
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this SpaceParticipant. |
participantProfileId - UUID
|
|
space - Space
|
Reads a single Space that is related to this SpaceParticipant. |
spaceId - UUID
|
|
userId - UUID
|
|
visitCount - BigInt
|
Example
{
"anonymousId": "abc123",
"email": "abc123",
"firstVisitedAt": Datetime,
"isAnonymous": false,
"lastVisitedAt": Datetime,
"name": "xyz789",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"visitCount": {}
}
SpacePassword
Example
{
"activeAt": Datetime,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"expiresAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"lastUsedAt": Datetime,
"name": "xyz789",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"useCount": 123
}
SpaceResource
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this SpaceResource. |
libraryItem - LibraryItem
|
Reads a single LibraryItem that is related to this SpaceResource. |
libraryItemId - UUID
|
|
space - Space
|
Reads a single Space that is related to this SpaceResource. |
spaceId - UUID
|
|
storyId - UUID
|
Example
{
"collection": CollectionsV2,
"libraryItem": LibraryItem,
"libraryItemId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"space": Space,
"spaceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
SpaceSearchInput
SpaceSearchResult
Example
{
"audienceName": "abc123",
"createdBy": "xyz789",
"description": "abc123",
"id": "4",
"metadata": "xyz789",
"name": "xyz789",
"organizationId": "xyz789",
"relevance": "abc123",
"updatedAt": "xyz789"
}
SpaceTemplate
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this SpaceTemplate. |
canDelete - Boolean!
|
|
canEdit - Boolean!
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
lastEditor - User
|
Reads a single User that is related to this SpaceTemplate. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this SpaceTemplate. |
organizationId - UUID
|
|
sourceId - UUID
|
|
spaceTemplateJson - JSON
|
|
spaceTemplateType - String
|
|
spaces - [Space!]!
|
Reads and enables pagination through a set of Space. |
updatedAt - Datetime
|
|
updatedBy - UUID
|
|
usage - String
|
|
usageCount - Int!
|
|
Example
{
"author": User,
"canDelete": false,
"canEdit": true,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": true,
"lastEditor": User,
"name": "abc123",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"sourceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"spaceTemplateJson": {},
"spaceTemplateType": "xyz789",
"spaces": [Space],
"updatedAt": Datetime,
"updatedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"usage": "abc123",
"usageCount": 123
}
Story
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this Story. |
canonicalName - String
|
|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this Story. |
commentCounts - StoryCommentsCount
|
Reads a single StoryCommentsCount that is related to this Story. |
createdAt - Datetime
|
|
createdBy - UUID
|
|
description - String
|
|
descriptionPlaintext - String
|
|
duration - BigFloat
|
|
id - UUID!
|
|
isDeleted - Boolean
|
|
isPublic - Boolean
|
|
memberOf - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
members - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
name - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
playbackMedia - StoryPlaybackMedia
|
Reads a single StoryPlaybackMedia that is related to this Story. |
presentation - String
|
|
preview - Media
|
Reads a single Media that is related to this Story. |
previewMediaId - UUID
|
|
publishStatus - StoryPublishStatus
|
Reads a single StoryPublishStatus that is related to this Story. |
storyPreference - StoryPreference
|
The story preferences including custom thumbnail settings |
storyPreferences - StoryPreference
|
Reads a single StoryPreference that is related to this Story. |
tags - [Tag!]!
|
Reads and enables pagination through a set of Tag. |
updatedAt - Datetime
|
|
viewAnalytics - AnalyticsStoryViewCount
|
Reads a single AnalyticsStoryViewCount that is related to this Story. |
visibility - String
|
|
Example
{
"author": User,
"canonicalName": "abc123",
"collection": CollectionsV2,
"commentCounts": StoryCommentsCount,
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"description": "abc123",
"descriptionPlaintext": "abc123",
"duration": BigFloat,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isDeleted": false,
"isPublic": false,
"memberOf": [CollectionMemberV2],
"members": [CollectionMemberV2],
"name": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"playbackMedia": StoryPlaybackMedia,
"presentation": "xyz789",
"preview": Media,
"previewMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"publishStatus": StoryPublishStatus,
"storyPreference": StoryPreference,
"storyPreferences": StoryPreference,
"tags": [Tag],
"updatedAt": Datetime,
"viewAnalytics": AnalyticsStoryViewCount,
"visibility": "abc123"
}
StoryComment
Fields
| Field Name | Description |
|---|---|
author - User
|
Reads a single User that is related to this StoryComment. |
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryComment. |
comment - String
|
|
createdAt - Datetime
|
|
createdBy - UUID
|
|
entityId - UUID
|
|
id - UUID
|
|
mentions - [UUID]
|
|
metadata - JSON
|
|
organizationId - UUID
|
|
parent - StoryComment
|
Reads a single StoryComment that is related to this StoryComment. |
parentId - UUID
|
|
reactions - [Reaction!]!
|
Reads and enables pagination through a set of Reaction. |
replies - [StoryComment!]!
|
Reads and enables pagination through a set of StoryComment. |
topic - String
|
|
updatedAt - Datetime
|
|
Example
{
"author": User,
"collection": CollectionsV2,
"comment": "xyz789",
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"entityId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"mentions": [
"0e9e3097-53ff-466d-b88b-ff087d99d435"
],
"metadata": {},
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"parent": StoryComment,
"parentId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"reactions": [Reaction],
"replies": [StoryComment],
"topic": "xyz789",
"updatedAt": Datetime
}
StoryCommentsCount
Fields
| Field Name | Description |
|---|---|
commentCounts - Story
|
Reads a single Story that is related to this StoryCommentsCount. |
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryCommentsCount. |
storyId - UUID!
|
|
totalComments - BigInt
|
|
totalCommentsAndReplies - BigInt
|
Example
{
"commentCounts": Story,
"nodeId": "4",
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalComments": {},
"totalCommentsAndReplies": {}
}
StoryGrant
StoryPlaybackMedia
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
id - UUID
|
|
isPublic - Boolean
|
|
latestStory - Story
|
Reads a single Story that is related to this StoryPlaybackMedia. |
liveblocksDocumentId - UUID
|
|
media - Media
|
Reads a single Media that is related to this StoryPlaybackMedia. |
mediaId - UUID
|
|
muxAssetId - String
|
|
muxPlaybackId - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryPlaybackMedia. |
storyId - UUID!
|
Example
{
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"isPublic": true,
"latestStory": Story,
"liveblocksDocumentId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"muxAssetId": "xyz789",
"muxPlaybackId": "abc123",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
StoryPreference
Fields
| Field Name | Description |
|---|---|
collection - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryPreference. |
ctaButtonLabel - String
|
|
ctaButtonUrl - String
|
|
cursor - JSON
|
|
customThumbnailMedia - Media
|
Reads a single Media that is related to this StoryPreference. |
customThumbnailMediaId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
resourceLinks - JSON
|
|
story - Story
|
Reads a single Story that is related to this StoryPreference. |
storyId - UUID!
|
|
thumbnailConfig - JSON
|
|
thumbnailType - String
|
Example
{
"collection": CollectionsV2,
"ctaButtonLabel": "xyz789",
"ctaButtonUrl": "xyz789",
"cursor": {},
"customThumbnailMedia": Media,
"customThumbnailMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"resourceLinks": {},
"story": Story,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"thumbnailConfig": {},
"thumbnailType": "xyz789"
}
StoryPublish
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
documentHash - String
|
|
id - UUID!
|
|
liveblocksDocumentId - UUID
|
|
mediaId - UUID
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this StoryPublish. |
organizationId - UUID
|
|
publishedBy - UUID
|
|
publisher - User
|
Reads a single User that is related to this StoryPublish. |
renderHash - String
|
|
state - String
|
|
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryPublish. |
storyId - UUID
|
|
storyPublishStatus - [StoryPublishStatus!]!
|
Reads and enables pagination through a set of StoryPublishStatus. |
updatedAt - Datetime
|
|
Example
{
"createdAt": Datetime,
"documentHash": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"liveblocksDocumentId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": 4,
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"publishedBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"publisher": User,
"renderHash": "abc123",
"state": "xyz789",
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"storyPublishStatus": [StoryPublishStatus],
"updatedAt": Datetime
}
StoryPublishCount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
story - CollectionsV2
|
Reads a single CollectionsV2 that is related to this StoryPublishCount. |
storyId - UUID!
|
|
totalPublishes - BigInt
|
Example
{
"nodeId": "4",
"story": CollectionsV2,
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"totalPublishes": {}
}
StoryPublishStatus
Fields
| Field Name | Description |
|---|---|
latestDocumentId - UUID
|
|
latestPublish - StoryPublish
|
Reads a single StoryPublish that is related to this StoryPublishStatus. |
latestPublishId - UUID
|
|
latestStory - Story
|
Reads a single Story that is related to this StoryPublishStatus. |
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String
|
|
storyId - UUID!
|
Example
{
"latestDocumentId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"latestPublish": StoryPublish,
"latestPublishId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"latestStory": Story,
"nodeId": "4",
"status": "xyz789",
"storyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
Tag
Fields
| Field Name | Description |
|---|---|
board - Board
|
Reads a single Board that is related to this Tag. |
canonicalName - String!
|
|
collectionV2 - CollectionsV2
|
Reads a single CollectionsV2 that is related to this Tag. |
createdAt - Datetime!
|
|
entityId - UUID!
|
|
expiresAt - Datetime
|
|
id - UUID!
|
|
organizationId - UUID!
|
|
stories - Story
|
Reads a single Story that is related to this Tag. |
users - User
|
Reads a single User that is related to this Tag. |
validAt - Datetime!
|
Example
{
"board": Board,
"canonicalName": "abc123",
"collectionV2": CollectionsV2,
"createdAt": Datetime,
"entityId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"expiresAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"stories": Story,
"users": User,
"validAt": Datetime
}
Transcript
Fields
| Field Name | Description |
|---|---|
assemblyTranscriptId - String
|
|
createdAt - Datetime!
|
|
id - UUID!
|
|
jsonVTT - JSON
|
|
media - Media
|
Reads a single Media that is related to this Transcript. |
mediaId - UUID
|
|
mediaSource - MediaSource
|
Reads a single MediaSource that is related to this Transcript. |
mediaSourceId - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
sentences - JSON
|
|
status - TranscriptStatus
|
|
updatedAt - Datetime!
|
|
vtt - String
|
|
words - JSON
|
Example
{
"assemblyTranscriptId": "xyz789",
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"jsonVTT": {},
"media": Media,
"mediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"mediaSource": MediaSource,
"mediaSourceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"sentences": {},
"status": "COMPLETE",
"updatedAt": Datetime,
"vtt": "abc123",
"words": {}
}
TranscriptStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
TurnstileCompletion
Fields
| Field Name | Description |
|---|---|
completedAt - Datetime
|
|
gate - TurnstileGate
|
Reads a single TurnstileGate that is related to this TurnstileCompletion. |
gateId - UUID
|
|
id - UUID!
|
|
metadata - JSON
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
participantProfile - ParticipantProfile
|
Reads a single ParticipantProfile that is related to this TurnstileCompletion. |
participantProfileId - UUID
|
|
policy - TurnstilePolicy
|
Reads a single TurnstilePolicy that is related to this TurnstileCompletion. |
turnstilePolicyId - UUID
|
Example
{
"completedAt": Datetime,
"gate": TurnstileGate,
"gateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"metadata": {},
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"participantProfile": ParticipantProfile,
"participantProfileId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"policy": TurnstilePolicy,
"turnstilePolicyId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}
TurnstileGate
Fields
| Field Name | Description |
|---|---|
completions - [TurnstileCompletion!]!
|
Reads and enables pagination through a set of TurnstileCompletion. |
config - JSON
|
|
createdAt - Datetime
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
orderIndex - Int
|
|
passwords - [TurnstilePassword!]!
|
Reads and enables pagination through a set of TurnstilePassword. |
policy - TurnstilePolicy
|
Reads a single TurnstilePolicy that is related to this TurnstileGate. |
required - Boolean
|
|
scope - String
|
|
turnstilePolicyId - UUID
|
|
type - String
|
|
updatedAt - Datetime
|
|
Example
{
"completions": [TurnstileCompletion],
"config": {},
"createdAt": Datetime,
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"orderIndex": 123,
"passwords": [TurnstilePassword],
"policy": TurnstilePolicy,
"required": true,
"scope": "abc123",
"turnstilePolicyId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"type": "xyz789",
"updatedAt": Datetime
}
TurnstilePassword
Fields
| Field Name | Description |
|---|---|
createdAt - Datetime
|
|
createdBy - UUID
|
|
gate - TurnstileGate
|
Reads a single TurnstileGate that is related to this TurnstilePassword. |
gateId - UUID
|
|
hint - String
|
|
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
passwordEncrypted - String
|
|
updatedAt - Datetime
|
Example
{
"createdAt": Datetime,
"createdBy": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"gate": TurnstileGate,
"gateId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"hint": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": 4,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"passwordEncrypted": "xyz789",
"updatedAt": Datetime
}
TurnstilePolicy
Fields
| Field Name | Description |
|---|---|
completions - [TurnstileCompletion!]!
|
Reads and enables pagination through a set of TurnstileCompletion. |
createdAt - Datetime
|
|
gates - [TurnstileGate!]!
|
Reads and enables pagination through a set of TurnstileGate. |
id - UUID!
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organization - Organization
|
Reads a single Organization that is related to this TurnstilePolicy. |
organizationId - UUID
|
|
resourceId - UUID
|
|
resourceType - String
|
|
status - String
|
|
updatedAt - Datetime
|
|
version - Int
|
|
Example
{
"completions": [TurnstileCompletion],
"createdAt": Datetime,
"gates": [TurnstileGate],
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"nodeId": "4",
"organization": Organization,
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"resourceId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"resourceType": "abc123",
"status": "xyz789",
"updatedAt": Datetime,
"version": 987
}
UUID
Description
A universally unique identifier as defined by RFC 4122.
Example
"0e9e3097-53ff-466d-b88b-ff087d99d435"
UniverseSearchInput
UniverseSearchResult
Fields
| Field Name | Description |
|---|---|
results - [UniverseSearchResultGroup!]!
|
Example
{"results": [UniverseSearchResultGroup]}
UniverseSearchResultGroup
UpdateMemoryEntryForAccountInput
UpdateMemoryEntryForSpaceInput
User
Fields
| Field Name | Description |
|---|---|
_legalWhoops - JSON
|
|
actionItems - [ActionPlanItem!]!
|
Reads and enables pagination through a set of ActionPlanItem. |
actionPlans - [ActionPlan!]!
|
Reads and enables pagination through a set of ActionPlan. |
addedLibraryItemTags - [LibraryItemTag!]!
|
Reads and enables pagination through a set of LibraryItemTag. |
analyticsStoryViews - [AnalyticsStoryViewer!]!
|
Reads and enables pagination through a set of AnalyticsStoryViewer. |
assignedActionItems - [ActionPlanItem!]!
|
Reads and enables pagination through a set of ActionPlanItem. |
authProviderId - String
|
|
authProviderMeta - JSON
|
|
authorOfSpaces - [Space!]!
|
Reads and enables pagination through a set of Space. |
avatar - Media
|
Reads a single Media that is related to this User. |
avatarMediaId - UUID
|
|
boards - [Board!]!
|
Reads and enables pagination through a set of Board. |
cardNarrationsByNarratedBy - [CardNarration!]!
|
Reads and enables pagination through a set of CardNarration. |
cards - [Card!]!
|
Reads and enables pagination through a set of Card. |
collectionMemberPreviews - [CollectionMemberPreviewV2!]!
|
Reads and enables pagination through a set of CollectionMemberPreviewV2. |
collectionMembers - [CollectionMemberV2!]!
|
Reads and enables pagination through a set of CollectionMemberV2. |
collectionsV2 - [CollectionsV2!]!
|
Reads and enables pagination through a set of CollectionsV2. |
createdActionPlanSections - [ActionPlanSection!]!
|
Reads and enables pagination through a set of ActionPlanSection. |
createdAt - Datetime
|
|
email - String
|
|
id - UUID
|
|
lastEditedTemplates - [SpaceTemplate!]!
|
Reads and enables pagination through a set of SpaceTemplate. |
legal - UserLegal
|
|
libraryItems - [LibraryItem!]!
|
Reads and enables pagination through a set of LibraryItem. |
libraryTags - [LibraryTag!]!
|
Reads and enables pagination through a set of LibraryTag. |
memberOf - [Organization!]
|
|
metrics - [Metric!]!
|
Reads and enables pagination through a set of Metric. |
organization - Organization
|
|
ownedAccounts - [Account!]!
|
Reads and enables pagination through a set of Account. |
pointOfContactOfSpaces - [Space!]!
|
Reads and enables pagination through a set of Space. |
preferences - UserPrefs
|
|
profile - UserProfilesV2
|
|
profile_v2 - [UserProfilesV2!]!
|
Reads and enables pagination through a set of UserProfilesV2. |
reportAllUserStorySessionsOverTimes - [ReportAllUserStorySessionsOverTime!]!
|
Reads and enables pagination through a set of ReportAllUserStorySessionsOverTime. |
reportAvgViewsPerCardOverTimeForUsers - [ReportAvgViewsPerCardOverTimeForUser!]!
|
Reads and enables pagination through a set of ReportAvgViewsPerCardOverTimeForUser. |
reportCardViewsByViewedBy - [ReportCardView!]!
|
Reads and enables pagination through a set of ReportCardView. |
reportNumCardsViewedPerStoryForTimePeriodForUsers - [ReportNumCardsViewedPerStoryForTimePeriodForUser!]!
|
Reads and enables pagination through a set of ReportNumCardsViewedPerStoryForTimePeriodForUser. |
reportSessionsListDuringTimePeriodV2SByViewedBy - [ReportSessionsListDuringTimePeriodV2!]!
|
Reads and enables pagination through a set of ReportSessionsListDuringTimePeriodV2. |
reportStoryAllMemberViewersByViewedBy - [ReportStoryAllMemberViewer!]!
|
Reads and enables pagination through a set of ReportStoryAllMemberViewer. |
reportStoryAllViewersByViewedBy - [ReportStoryAllViewer!]!
|
Reads and enables pagination through a set of ReportStoryAllViewer. |
reportStoryAllViewersV2SByViewedBy - [ReportStoryAllViewersV2!]!
|
Reads and enables pagination through a set of ReportStoryAllViewersV2. |
reportTotalUserStorySessionsDuringTimePeriods - [ReportTotalUserStorySessionsDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportTotalUserStorySessionsDuringTimePeriod. |
reportUserCardViewsListDuringTimePeriodsByViewedBy - [ReportUserCardViewsListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportUserCardViewsListDuringTimePeriod. |
reportViewersListDuringTimePeriodsByViewedBy - [ReportViewersListDuringTimePeriod!]!
|
Reads and enables pagination through a set of ReportViewersListDuringTimePeriod. |
responses - [ActionPlanItemResponse!]!
|
Reads and enables pagination through a set of ActionPlanItemResponse. |
spaceActivityEvents - [SpaceActivityEvent!]!
|
Reads and enables pagination through a set of SpaceActivityEvent. |
spaceInternalParticipants - [SpaceInternalParticipant!]!
|
Reads and enables pagination through a set of SpaceInternalParticipant. |
spaceTemplates - [SpaceTemplate!]!
|
Reads and enables pagination through a set of SpaceTemplate. |
status - String
|
|
stories - [Story!]!
|
Reads and enables pagination through a set of Story. |
storyCommentsByCreatedBy - [StoryComment!]!
|
Reads and enables pagination through a set of StoryComment. |
storyPublishesByPublishedBy - [StoryPublish!]!
|
Reads and enables pagination through a set of StoryPublish. |
storyViews - [ReportStoryView!]!
|
Reads and enables pagination through a set of ReportStoryView. |
tags - [Tag!]!
|
Reads and enables pagination through a set of Tag. |
title - String
|
|
updatedAt - Datetime
|
|
viewerPageTimeSpent - [LibraryItemViewerPageTimeSpent!]!
|
Reads and enables pagination through a set of LibraryItemViewerPageTimeSpent. |
viewerTimeSpent - [LibraryItemViewerTimeSpent!]!
|
Reads and enables pagination through a set of LibraryItemViewerTimeSpent. |
Example
{
"_legalWhoops": {},
"actionItems": [ActionPlanItem],
"actionPlans": [ActionPlan],
"addedLibraryItemTags": [LibraryItemTag],
"analyticsStoryViews": [AnalyticsStoryViewer],
"assignedActionItems": [ActionPlanItem],
"authProviderId": "abc123",
"authProviderMeta": {},
"authorOfSpaces": [Space],
"avatar": Media,
"avatarMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"boards": [Board],
"cardNarrationsByNarratedBy": [CardNarration],
"cards": [Card],
"collectionMemberPreviews": [CollectionMemberPreviewV2],
"collectionMembers": [CollectionMemberV2],
"collectionsV2": [CollectionsV2],
"createdActionPlanSections": [ActionPlanSection],
"createdAt": Datetime,
"email": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"lastEditedTemplates": [SpaceTemplate],
"legal": UserLegal,
"libraryItems": [LibraryItem],
"libraryTags": [LibraryTag],
"memberOf": [Organization],
"metrics": [Metric],
"organization": Organization,
"ownedAccounts": [Account],
"pointOfContactOfSpaces": [Space],
"preferences": UserPrefs,
"profile": UserProfilesV2,
"profile_v2": [UserProfilesV2],
"reportAllUserStorySessionsOverTimes": [
ReportAllUserStorySessionsOverTime
],
"reportAvgViewsPerCardOverTimeForUsers": [
ReportAvgViewsPerCardOverTimeForUser
],
"reportCardViewsByViewedBy": [ReportCardView],
"reportNumCardsViewedPerStoryForTimePeriodForUsers": [
ReportNumCardsViewedPerStoryForTimePeriodForUser
],
"reportSessionsListDuringTimePeriodV2SByViewedBy": [
ReportSessionsListDuringTimePeriodV2
],
"reportStoryAllMemberViewersByViewedBy": [
ReportStoryAllMemberViewer
],
"reportStoryAllViewersByViewedBy": [
ReportStoryAllViewer
],
"reportStoryAllViewersV2SByViewedBy": [
ReportStoryAllViewersV2
],
"reportTotalUserStorySessionsDuringTimePeriods": [
ReportTotalUserStorySessionsDuringTimePeriod
],
"reportUserCardViewsListDuringTimePeriodsByViewedBy": [
ReportUserCardViewsListDuringTimePeriod
],
"reportViewersListDuringTimePeriodsByViewedBy": [
ReportViewersListDuringTimePeriod
],
"responses": [ActionPlanItemResponse],
"spaceActivityEvents": [SpaceActivityEvent],
"spaceInternalParticipants": [SpaceInternalParticipant],
"spaceTemplates": [SpaceTemplate],
"status": "abc123",
"stories": [Story],
"storyCommentsByCreatedBy": [StoryComment],
"storyPublishesByPublishedBy": [StoryPublish],
"storyViews": [ReportStoryView],
"tags": [Tag],
"title": "xyz789",
"updatedAt": Datetime,
"viewerPageTimeSpent": [LibraryItemViewerPageTimeSpent],
"viewerTimeSpent": [LibraryItemViewerTimeSpent]
}
UserEmailPrefs
Fields
| Field Name | Description |
|---|---|
cardMention - EmailFrequency
|
|
commentMention - EmailFrequency
|
|
commentReaction - EmailFrequency
|
|
marketing - EmailFrequency
|
|
product - EmailFrequency
|
|
spaceJoined - EmailFrequency
|
|
storyComment - EmailFrequency
|
|
storyViewed - EmailFrequency
|
Example
{
"cardMention": "DIGEST",
"commentMention": "DIGEST",
"commentReaction": "DIGEST",
"marketing": "DIGEST",
"product": "DIGEST",
"spaceJoined": "DIGEST",
"storyComment": "DIGEST",
"storyViewed": "DIGEST"
}
UserLegal
Fields
| Field Name | Description |
|---|---|
privacy - UserLegalAgreement
|
|
toc - UserLegalAgreement
|
Example
{
"privacy": UserLegalAgreement,
"toc": UserLegalAgreement
}
UserLegalAgreement
UserNotificationKinds
UserNotificationPrefs
Fields
| Field Name | Description |
|---|---|
global - UserNotificationKinds
|
Example
{"global": UserNotificationKinds}
UserPrefs
Fields
| Field Name | Description |
|---|---|
avatarMediaId - String
|
|
avatarUrl - String
|
|
email - UserEmailPrefs
|
|
fullName - String
|
|
jobCategory - String
|
|
notifications - UserNotificationPrefs
|
|
pronouns - String
|
|
story - UserStoryPrefs
|
|
theme - SiteTheme
|
|
title - String
|
Example
{
"avatarMediaId": "xyz789",
"avatarUrl": "xyz789",
"email": UserEmailPrefs,
"fullName": "xyz789",
"jobCategory": "abc123",
"notifications": UserNotificationPrefs,
"pronouns": "xyz789",
"story": UserStoryPrefs,
"theme": "DARK",
"title": "abc123"
}
UserProfilesV2
Fields
| Field Name | Description |
|---|---|
avatar - Media
|
Reads a single Media that is related to this UserProfilesV2. |
avatarMediaId - UUID
|
|
avatarStorageKey - String
|
|
avatarUrl - String
|
|
createdAt - Datetime
|
|
defaultAvatarUri - String
|
|
familyName - String
|
|
givenName - String
|
|
id - UUID!
|
|
jobCategory - String
|
|
name - String
|
|
nickname - String
|
|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
organizationId - UUID
|
|
title - String
|
|
updatedAt - Datetime
|
|
user - User
|
Reads a single User that is related to this UserProfilesV2. |
userId - UUID
|
Example
{
"avatar": Media,
"avatarMediaId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"avatarStorageKey": "abc123",
"avatarUrl": "xyz789",
"createdAt": Datetime,
"defaultAvatarUri": "abc123",
"familyName": "abc123",
"givenName": "abc123",
"id": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"jobCategory": "abc123",
"name": "abc123",
"nickname": "xyz789",
"nodeId": "4",
"organizationId": "0e9e3097-53ff-466d-b88b-ff087d99d435",
"title": "abc123",
"updatedAt": Datetime,
"user": User,
"userId": "0e9e3097-53ff-466d-b88b-ff087d99d435"
}