Story
This API is the main entry point for creating, editing and publishing analytics throught the Presalytics API
Data & analytics#openapi#analytics
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This API is the main entry point for creating, editing and publishing analytics throught the Presalytics API
Endpoints 42
Story
- GETStory: Get List of User Stories
/?include_relationships=true&include_outline=trueReturns a list of stories for this user identifie via the access token presentated to the api - POSTStory: Upload
/?include_outline=trueUpload new story to presalytics api - POSTStory: Upload a File
/file?include_outline=trueUpload new story to presalytics api via an Open Office Xml file - POSTStory: Upload a File (base64)
/file/json?include_outline=trueUpload new story to presalytics api via an Open Office Xml file - GETStory: Get by Id
/:id?include_relationships=true&include_outline=true&full=true&refresh_cache=trueReturns story metadata, inlcuding json object with story outline - PUTStory: Modify
/:id?include_outline=trueUpdate story metadata, including story outline - DELETEStory: Delete by Id
/:idRemove a story and dependant data. - GETStory: View Analytics
/:id/analyticsreturns an html document containing session and event metrics for the story - POSTStory: Upload a File To Existing Story
/:id/file?replace_existing=true&obsolete_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_outline=trueUpload a file to an existing story - GETStory: Download Updated File
/:id/file/:ooxml_automation_idRedtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) - DELETEStory: Delete Subdocument
/:id/file/:ooxml_automation_idDeletes a subdcoument of this story (e.g., .pptx, .docx, .xlsx) - GETStory: Get Story Outline
/:id/outlineReturns Story's outline - POSTStory: Post Story Outline
/:id/outlineUpdate a story outline. - GETStory: Public Link to Story Reveal.js Document
/:id/public/returns an html document containing a reveal.js epresentation of the story, if the story if set to is_public = True - GETStory: Get Story at Reveal.js Document
/:id/revealreturns an html document containing a reveal.js epresentation of the story - GETStory: Get Story Status
/:id/statusReturns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid)
Story Collaborators
- GETStory Collaborators: List
/:id/collaboratorsGets a list users that can read or edit this story - POSTStory Collaborators: Add New User
/:id/collaboratorsAdd a colloborator to this story - POSTStory Collaborators: Edit Inactive User Permission
/:id/collaborators/inactiveEdit story permissions for inactive users. Requires admin rights. - GETStory Collaborators: Access Permissions
/:id/collaborators/:story_collaborator_useridData to help you understand the access rights of a particular collaborator on this story - PUTStory Collaborators: Edit Access Rights
/:id/collaborators/:story_collaborator_useridModify a user's access right to this story (e.g., grant edit permissions) - DELETEStory Collaborators: Remove User
/:id/collaborators/:story_collaborator_useridRemove a collaborator from this story
Permissions
- GETPermissions: List Permission Types
/permission_typesReturns a list of possible user permission types - GETPermissions: Story Authorization for a User
/:id/collaborators/authorize/:story_collaborator_userid/:permissiontypeCheck whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden
Cache
- POSTCache: Store Subdocument
/cacheAn endpoint for Presalytics Renderers to cache html subdocuments for subsequent retrieval by the browser. Documents Are retrieved via token expire after 1… - GETCache: Get Subdocument
/cache/:nonceAn endpoint for broswer retreive html documents that were cached durin the rendering process via a nonce (token)
Restricted
- POSTCollborators: Bulk Update (Admin Only)
/collaboratorsAllows for bulk updates on collaborator metadata. Restricted to internal admins
Schemas
- GETStory Outline Schema
/outline-schema/:schema_version/story-outline.jsonJson Schema for validating Story Outline objects
Sessions
- GETSessions: Get
/sessions/:session_id?include_relationships=trueGet session metadata - DELETESessions: Delete by Id
/sessions/:session_idRemove a session and dependant data. - GETSessions: List Story Sessions
/:id/sessions?include_relationships=trueGet a list of sessions asscoaited with this story - POSTSessions: Create a Session
/:id/sessionsCreate a new session
Views
- GETViews: List Session Views
/sessions/:session_id/viewsGet data for all views in a session - POSTViews: Create A Session View
/sessions/:session_id/viewsCreate a page view object for a viewing session - GETViews: Get View
/views/:view_idGet view meta data - DELETEViews: Delete by Id
/views/:view_idRemove a view and dependant data.
Events
- GETEvents: List Events
/:id/eventsGet a list of Events available to users of this story - POSTEvents: Manage Events
/:id/eventsAdd a message to the Story's conversation
Conversation
- GETConversation: List Conversation Messages
/:id/messagesGet a list of messages that have been send in this story - POSTConversation: Send a Message
/:id/messagesAdd a message to the Story's conversation
- GETEnvironment: Get
/environment/pass rendering metadata to the client-side scripts - GETSpecification: No tags
/no_tags_specjson-formatted version of this spec with the tags removed to help with codegen processes
API details
- Authentication
- A bearer token in the Authorization header
- Operations
- 42 operations on 28 pathsGET 22POST 13DELETE 5PUT 2
- Main resources
- Story 16Story Collaborators 6Sessions 4Views 4Cache 2Conversation 2Events 2Permissions 2Restricted 1Schemas 1
- Response formats
application/jsontext/htmlapplication/vnd.openxmlformats-officedocument.presentationml.presentationapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet- Description format
- OpenAPI 3.0.0, API version
0.3.1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Story in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Story collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Story: Get List of User Stories” (GET /?include_relationships=true&include_outline=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Story?
This API is the main entry point for creating, editing and publishing analytics throught the Presalytics API It is listed under Data & analytics and has 42 endpoints.
Who publishes the Story?
It is listed from Presalytics's public API description (an OpenAPI document), not published by Presalytics on Swastik Codes. Anyone who controls presalytics.io can claim the profile by adding a DNS TXT record.
How do I authenticate with the Story?
With A bearer token in the Authorization header.
How many endpoints does the Story have?
42 operations on 28 paths (22 GET, 13 POST, 5 DELETE, 2 PUT). The largest groups are Story, Story Collaborators, Sessions, Views.
Is forking the Story free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.