Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HappyOrNot alerts API

Endpoints and data definitions related to alerts which have been triggered by incoming feedback, based on alert specfications

HappyOrNot alerts API is one of 21 APIs that HappyOrNot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.happy-or-not.com/v2.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.happy-or-not.com/v2/
Authentication
API Key, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

HappyOrNot alerts API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-HON-API-Token (ApiTokenAuth). An API key is passed in the query as auth (ApiTokenViaQueryStringAuth). By default, every request must be authenticated.

  • ApiTokenAuth — API Tokens are managed in Organization Settings page in Analytics
  • ApiTokenViaQueryStringAuth — E.g. /some/path?auth=

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

alerts 1

Endpoints and data definitions related to alerts which have been triggered by incoming feedback, based on alert specfications

GET
/alerts.{format}
List alerts
listAlerts 9 params → 200400401403

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Alert (11 properties). Each schema is shown below with its type and property counts.

Alert
object
11 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

happyornot-alerts-api-openapi.yml Raw ↑

Other APIs HappyOrNot publishes across the network.

HappyOrNot alert-comments API
HappyOrNot alert-specifications API
HappyOrNot button-feedbacks API
HappyOrNot contact-details API
HappyOrNot custom-data-fields API
HappyOrNot demographics API
HappyOrNot experience-points API
HappyOrNot follow-up-feedbacks API
HappyOrNot follow-up-option-localizations API
HappyOrNot follow-up-options API
HappyOrNot follow-up-question-localizations API
HappyOrNot follow-up-questions API