Chart 2

get

/chart/templates/:uuid (authenticated)

Generate embed/inject snippets for a chart uuid

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.

Accepted Restful Arguments

uuid: undocumented
get

/profile/charts/collab (authenticated)

Get all the charts for which the user is a collaborator

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.

Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
get

/chart/accessto/:uuid (authenticated)

Check if a user has permission to edit a chart

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.

Accepted Restful Arguments

uuid: undocumented
get

/public/charts/search

Get all the charts! (search)

Accepted Query Arguments

string query: The search string
integer page: The desired page
integer pageSize: The desired page size
post

/:teamid/data/:dataid

Updates data info

Accepted Body Arguments

{
// The data
data: json,
// live or not
live: bool,
// referenced or not
referenced: bool,
// name of data
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
dataid: undocumented
post

/:teamid/data

Creates new data info

Accepted Body Arguments

{
// data
The: details,
//
live: live,
//
name: name,
//
provider: provider,
}
Accepted Restful Arguments

teamid: The id of the team to act on
get

/:teamid/data

Get all data by team

Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/data/:hash

Accepted Restful Arguments

hash: undocumented
get

/public/charts

Get all charts

Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
post

/team/:teamid/chart (authenticated)

Create a new chart

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

  1. create_chart
Accepted Body Arguments

{
// dataId
The: dataId,
// charts data is referenced or not
whether: referenced,
}
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/chart/:chartid/views (authenticated)

Get the view history for a chart

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

  1. view_history
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
get

/show/chart/:uuid/:version

Get a single public chart version.

Accepted Restful Arguments

uuid: undocumented
version: undocumented
Returns

{
// The hash of the chart
uuid: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
// The username for the owner
username: string,
}
get

/show/chart/:uuid

Get a single public chart - fetches the latest version.

Accepted Restful Arguments

uuid: undocumented
Returns

{
// The hash of the chart
uuid: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
}
get

/team/:teamid/chart/:chartid

Get a single chart - fetches the latest version

Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
Returns

{
// The ID of the chart
chart_id: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
// Wether or not the chart is private
private: boolean,
// The username for the owner
username: string,
}
get

/team/:teamid/chart/:chartid/:versionid

Get a single chart - with a specified version

Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
versionid: undocumented
Returns

{
// The ID of the chart
chart_id: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
// Wether or not the chart is private
private: boolean,
// The username for the owner
username: string,
}
get

/chart/:chartid/:versionid

Get a single chart - with a specified version, only works for public charts

Accepted Restful Arguments

chartid: The id of the chart to act on
versionid: undocumented
Returns

{
// The ID of the chart
chart_id: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
// Wether or not the chart is private
private: boolean,
// The username for the owner
username: string,
}
get

/team/:teamid/charts (authenticated)

Get all the charts a user has access to in a given team

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

  1. view_charts
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/charts/published (authenticated)

Get all published charts a user has access to in a given team

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

  1. view_charts
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/division/charts/all (authenticated)

Get all the charts a user has access to in a given team with no division set

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

  1. view_charts
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/division/:divisionid/charts (authenticated)

Get all the charts a user has access to in a given division

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

  1. view_charts
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented
get

/division/:divisionid/charts/deleted (authenticated)

Get all the deleted charts in a team

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

  1. chart_trash
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented
get

/team/:teamid/charts/deleted (authenticated)

Get all the deleted charts in a team

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

  1. chart_trash
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/charts/public

Get all the public charts of a team

Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
delete

/team/:teamid/chart/:chartid

Delete a chart

Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
post

/team/:teamid/chart/:chartid/recover

Undelete a chart

Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
post

/team/:teamid/chart/:chartid/duplicate (authenticated)

Duplicate chart

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

  1. duplicate_chart
Accepted Body Arguments

{
// If chart is a theme
is_theme: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
post

/team/:teamid/chartmeta/:chartid

Update chart meta

Accepted Body Arguments

{
// The chart name
name: string,
// If the chart is private or not
private: boolean,
// The charts tags including new ones to add
tags: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
post

/team/:teamid/chartdivision/:chartid (authenticated)

Update chart division

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

  1. subteam_management
Accepted Body Arguments

{
// The division id to change to
division: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
post

/team/:teamid/chart/:chartid

Update a chart version

Accepted Body Arguments

{
// The chart body
data: json,
// The dataId
dataId: integer,
// If the data is live
live: bool,
}
Accepted Restful Arguments

teamid: The id of the team to act on
chartid: The id of the chart to act on
get

/team/:teamid/division/charts/all/search

Get all the charts within a team with no divisions! (search)

Accepted Query Arguments

string query: The search string
string tags: The tags string
string creator: The creator
integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/charts/search

Get all the charts within a team! (search)

Accepted Query Arguments

string query: The search string
string tags: The tags string
string creator: The creator
integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on
get

/division/:divisionid/charts/search

Get all the charts within a division! (search)

Accepted Query Arguments

string query: The search string
string tags: The tags string
string creator: The creator
integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented
get

/charts/:teamid/tags

Get all the chart tags

Accepted Restful Arguments

teamid: The id of the team to act on
get

/public/popularcharts

Get most popular charts

post

/private/chart/:chartid

Get private chart

Accepted Body Arguments

{
// Password for the chart
password: string,
}
Accepted Restful Arguments

chartid: The id of the chart to act on
get

/share/:uuid

Get private chart

Accepted Restful Arguments

uuid: undocumented
Did you find what you were looking for? Thank you! There was a problem submitting your feedback. Please try again later.