This API request provides a class result ('Happy' or 'Unhappy') based on a requested mini-survey with answers ranging from 1 (Totally Disagree) to 5 (Totally Agree). The AI algorithm consists of ML (Machine Learning) techniques for the Classification task. For more information about the model, please contact us. We acknowledge the researchers involved in this study and thank them for providing the Dataset for Analysis. We here cite the dataset: 'Koczkodaj, W. (2017). Somerville Happiness Survey [Dataset]. UCI Machine Learning Repository.'
EXAMPLE USE OF "/hapiness" endpoint for required input parameters:CALL: /hapiness?X1=3&X2=3&X3=5&X4=3&X5=4&X6=4RESPONSE:{
"Value Prediction": "Happy"
}hapiness - Endpoint Features
| Object | Description |
|---|---|
X1 |
[Required] the availability of information about the city services |
X2 |
[Required] the cost of housing |
X3 |
[Required] the overall quality of public schools |
X4 |
[Required] your trust in the local police |
X5 |
[Required] the maintenance of streets and sidewalks |
X6 |
[Required] the availability of social community events |
{
"Value Prediction": "Happy"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10309/hapiness?X1=Required&X2=Required&X3=Required&X4=Required&X5=Required&X6=Required' --header 'Authorization: Bearer YOUR_API_KEY'
List all vars and possible values.
listallvars - Endpoint Features
| Object | Description |
|---|
{
"X1": "the availability of information about the city services",
"X2": "the cost of housing",
"X3": "the overall quality of public schools",
"X4": "your trust in the local police",
"X5": "the maintenance of streets and sidewalks",
"X6": "the availability of social community events"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10310/listallvars' --header 'Authorization: Bearer YOUR_API_KEY'
Info for this API ()
info - Endpoint Features
| Object | Description |
|---|
{
"API Info:": "This API requests per values provide class result ('Happy' or 'Unhappy'). The AI algorithm consists of ML (Machine Learning) techniques for Classification task. Please contact us for more information about the model. We acknowledge the researchers involved in this study and thank them for providing the Dataset for Analysis. We here cite the dataset: 'Koczkodaj, W. (2017). Somerville Happiness Survey [Dataset]. UCI Machine Learning Repository. https://doi.org/10.24432/C5PW36.'"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10311/info' --header 'Authorization: Bearer YOUR_API_KEY'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The "hapiness" endpoint returns a classification result indicating emotional state as either 'Happy' or 'Unhappy'. The "listallvars" endpoint provides a list of variables related to factors influencing happiness, while the "info" endpoint offers general information about the API and its underlying model.
The "hapiness" endpoint response includes "Value Prediction" indicating the emotional classification. The "listallvars" response contains variable names (e.g., "X1", "X2") and their descriptions, while the "info" endpoint provides a summary of the API's functionality and data sources.
Responses are structured in JSON format. For "hapiness", it returns a single key-value pair. The "listallvars" endpoint returns multiple key-value pairs for each variable, and the "info" endpoint provides a comprehensive overview in a single JSON object.
The "hapiness" endpoint provides emotional classifications, the "listallvars" endpoint details various factors affecting happiness, and the "info" endpoint gives insights into the API's functionality and data sources.
Currently, the API does not support customizable parameters for the "hapiness" or "listallvars" endpoints. Users can simply call these endpoints to receive the predefined data. Future enhancements may allow for more tailored requests.
The data utilized by the Joyful Insights Forecasting AI API is based on the Somerville Happiness Survey dataset, provided by Koczkodaj, W. (2017). This dataset is available in the UCI Machine Learning Repository, ensuring a reliable source for analysis.
Typical use cases include sentiment analysis for social research, understanding community well-being, and enhancing user experience in applications that require emotional insights. The data can help organizations gauge public sentiment on various issues.
Users can leverage the "hapiness" classification to assess emotional trends in their data, while the "listallvars" information can guide them in identifying key factors influencing happiness. This can inform decision-making in community planning or service improvements.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
To obtain your API key, you first need to sign in to your account and subscribe to the API you want to use. Once subscribed, go to your Profile, open the Subscription section, and select the specific API. Your API key will be available there and can be used to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
If you don’t cancel before the 7th day, your free trial will end automatically and your subscription will switch to a paid plan under the same plan you originally subscribed to, meaning you will be charged and gain access to the API calls included in that plan.
The free trial ends when you reach 50 API requests or after 7 days, whichever comes first.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost, so you can test our APIs without any commitment.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
Service Level:
100%
Response Time:
474ms
Service Level:
100%
Response Time:
48ms
Service Level:
100%
Response Time:
46ms
Service Level:
100%
Response Time:
920ms
Service Level:
100%
Response Time:
2,036ms
Service Level:
100%
Response Time:
1,845ms
Service Level:
100%
Response Time:
239ms
Service Level:
100%
Response Time:
183ms
Service Level:
100%
Response Time:
78ms
Service Level:
100%
Response Time:
121ms
Service Level:
100%
Response Time:
59ms
Service Level:
100%
Response Time:
56ms
Service Level:
100%
Response Time:
2,690ms
Service Level:
100%
Response Time:
52ms
Service Level:
100%
Response Time:
4,177ms
Service Level:
100%
Response Time:
534ms
Service Level:
100%
Response Time:
1,660ms
Service Level:
100%
Response Time:
2,094ms
Service Level:
100%
Response Time:
1,815ms
Service Level:
100%
Response Time:
3,149ms