apyhub-logo
60 atoms
Base tier

About

This Utility API allows you to generate a stacked graph for the provided JSON data.
The use of stacked graphs in applications can improve data visualization, decision-making, engagement, user experience, customization, and accessibility, and making it easier for users to understand complex information and trends. By presenting data in a visual format, users can make more informed decisions based on the insights provided by the chart.
The graphs could be generated in two color schemes, light and dark modes.
Endpoint Selector
Output

API Playground

This API endpoint does not have a playground yet. Please check back later.

Documentation

download image
POST
https://api.apyhub.com/generate/charts/stacked/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/charts/stacked/file?output=sample.png' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
"title":"Simple Stacked Chart",
6
"theme":"Dark",
7
"data":[
8
{
9
"name":"stack 1",
10
"values":[
11
{
12
"label":"10K",
13
"value":10
14
},
15
{
16
"label":"20K",
17
"value":20
18
},
19
{
20
"label":"15K",
21
"value":12.5
22
}]
23
},
24
{
25
"name":"stack2",
26
"values":[
27
{
28
"label":"30K",
29
"value":30
30
},
31
{
32
"label":"40K",
33
"value":40
34
},
35
{
36
"label":"15K",
37
"value":12.5
38
}]
39
}
40
]
41
}'
Method: POST
Content Type: application/json
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name for the generated stacked graph. If no output attribute is provided, the default file name will be output.png
Request Body
AttributeTypeMandatoryDescription
titleStringNoTitle for the graph
themeStringNoTheme for the graph - accepted values are Dark or Light, defaults to Light theme
dataArray of Stack ObjectsYesThe data for the stacked graph
data[a].nameStringYesThe name for the stack
data[a].valuesArray of Bar objectsYesThe values for the bars within the stacked graph
data[a].values[b].labelStringYesThe label for the bar
data[a].values[b].valueNumberYesThe value for the bar
Sample Response
A successful request returns the generated stacked graph file.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the content is empty
500If any unexpected error occurs while processing the request

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.