presalytics.io – story

Tools (44)

Extracted live via the executor SDK.

• cache.cacheNonceGet

  An endpoint for broswer retreive html documents that were cached durin the rendering process via a nonce (token)

• cache.cachePost

  An endpoint for Presalytics Renderers to cache html subdocuments for subsequent retrieval by the browser. Documents Are retrieved via token expire after 1 minute.

• conversation.storyIdMessagesGet

  Get a list of messages that have been send in this story

• conversation.storyIdMessagesPost

  Add a message to the Story's conversation

• environment.getEnvironment

  pass rendering metadata to the client-side scripts

• events.storyIdEventsGet

  Get a list of Events available to users of this story

• events.storyIdEventsPost

  Add a message to the Story's conversation

• noTagsSpec.specNoTags

  json-formatted version of this spec with the tags removed to help with codegen processes

• permissions.storyIdCollaboratorsUseridPermissiontypeGet

  Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden

• permissions.storyPermissionTypesGet

  Returns a list of possible user permission types

• restricted.collaboratorsPost

  Allows for bulk updates on collaborator metadata. Restricted to internal admins

• schemas.storyOutlineSchema

  Json Schema for validating Story Outline objects

• sessions.sessionIdDelete

  Remove a session and dependant data.

• sessions.sessionIdGet

  Get session metadata

• sessions.storyIdSessionPost

  Create a new session

• sessions.storyIdSessionsGet

  Get a list of sessions asscoaited with this story

• story.storyGet

  Returns a list of stories for this user identifie via the access token presentated to the api

• story.storyIdAnalytics

  returns an html document containing session and event metrics for the story

• story.storyIdDelete

  Remove a story and dependant data.

• story.storyIdFileOoxmlautomationidDelete

  Deletes a subdcoument of this story (e.g., .pptx, .docx, .xlsx)

• story.storyIdFileOoxmlautomationidGet

  Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx)

• story.storyIdFilePost

  Upload a file to an existing story

• story.storyIdGet

  Returns story metadata, inlcuding json object with story outline

• story.storyIdOutlineGet

  Returns Story's outline

• story.storyIdOutlinePost

  Update a story outline.

• story.storyIdPublic

  returns an html document containing a reveal.js epresentation of the story, if the story if set to is_public = True

• story.storyIdPut

  Update story metadata, including story outline

• story.storyIdReveal

  returns an html document containing a reveal.js epresentation of the story

• story.storyIdStatusGet

  Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid)

• story.storyPost

  Upload new story to presalytics api

• story.storyPostFile

  Upload new story to presalytics api via an Open Office Xml file

• story.storyPostFileJson

  Upload new story to presalytics api via an Open Office Xml file

• storyCollaborators.storyIdCollaboratorsGet

  Gets a list users that can read or edit this story

• storyCollaborators.storyIdCollaboratorsInactivePost

  Edit story permissions for inactive users. Requires admin rights.

• storyCollaborators.storyIdCollaboratorsPost

  Add a colloborator to this story

• storyCollaborators.storyIdCollaboratorsUseridDelete

  Remove a collaborator from this story

• storyCollaborators.storyIdCollaboratorsUseridGet

  Data to help you understand the access rights of a particular collaborator on this story

• storyCollaborators.storyIdCollaboratorsUseridPut

  Modify a user's access right to this story (e.g., grant edit permissions)

• views.sessionsIdViewsGet

  Get data for all views in a session

• views.sessionsIdViewsPost

  Create a page view object for a viewing session

• views.viewsIdDelete

  Remove a view and dependant data.

• views.viewsIdGet

  Get view meta data

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools