Generate Pie Chart API
ApyHub
60 atoms
Base tier
About
This Utility API allows you to generate a pie chart for the provided JSON data.
By presenting data in a visual format, users can make more informed decisions based on the insights provided by the chart. Including pie charts in an application can improve the overall user experience by providing a more intuitive and user-friendly interface for data analysis.
The charts could be generated in two color schemes,
light
and dark
modes.Select API Endpoints
Output
API Playground
API Documentation
download image
POST
https://api.apyhub.com/generate/charts/pie/file
Request example
Method:
POST
Content Type:
application/json
Query Parameter(s)
Attribute | Type | Mandatory | Description |
---|---|---|---|
output | String | No | The name for the generated pie chart. If no output attribute is provided, the default file name will be output.png |
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
title | String | No | Title for the chart |
theme | String | No | Theme for the chart - accepted values are Dark or Light , defaults to Light theme |
data | Array of Objects | Yes | The data for the pie chart |
data[a].label | String | Yes | The label for the pie chart item |
data[a].value | Number | Yes | The value for the pie chart item |
Sample Response
A successful request returns the generated pie chart file.
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
200 | The request was successful. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - the content is empty |
500 | If any unexpected error occurs while processing the request |
Authentication
All API 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 your workspace settings (on the left side of the navbar) and go to “API Keys".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
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.
Table of contents