Layouts

post

/team/:teamid/story (authenticated)

Create a new story

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

create_chart

Accepted Body Arguments


 {
 // story config
 The: data,
 }

Accepted Restful Arguments


 teamid: The id of the team to act on

get

/team/:teamid/story/:storyid (authenticated)

Get a single story - fetches the latest version

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

create_chart

Accepted Restful Arguments


 teamid: The id of the team to act on
 storyid: undocumented

Returns


 {
 // The ID of the story
 story_id: number,
 // The story version
 version: number,
 // The timestamp for this version
 creation_time: date,
 // The story data
 data: json,
 // The username for the owner
 username: string,
 }

post

/team/:teamid/story/:storyid (authenticated)

Update a story version

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

create_chart

Accepted Body Arguments


 {
 // The story body
 data: json,
 }

Accepted Restful Arguments


 teamid: The id of the team to act on
 storyid: undocumented

post

/team/:teamid/story/:storyid/embed (authenticated)

Generates embed and inject scripts for a given story

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

publish

Accepted Body Arguments


 {
 // whether to notify us if you want this project to be in the inspired section.
 inspired: boolean,
 }

Accepted Restful Arguments


 teamid: The id of the team to act on
 storyid: undocumented

post

/team/:teamid/storymeta/:storyid (authenticated)

Update story meta

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

create_chart

Accepted Body Arguments


 {
 // The story name
 name: string,
 // If the story is deleted or not
 private: boolean,
 }

Accepted Restful Arguments


 teamid: The id of the team to act on
 storyid: undocumented

post

/team/:teamid/story/:storyid/duplicate (authenticated)

Duplicate story

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

duplicate_chart

Accepted Body Arguments


 {
 // Is a theme
 is_theme: string,
 }

Accepted Restful Arguments


 teamid: The id of the team to act on
 storyid: undocumented