logo
API docs by Redocly

Mood Metrics API (v1.0.0)

Download OpenAPI specification:

The Mood Metrics API provides powerful sentiment analysis on submitted text, with optional long-term tracking and anomaly detection using feed IDs. Perfect for monitoring brand perception, social media streams, customer feedback, support tickets, or real-time news sentiment.

  • Sentiment classification
  • Intent classification
  • Confidence scores (0.0 – 1.0) for each primary emotion
  • Language-agnostic – works with any UTF-8 text
  • RESTful design with predictable resource-oriented URLs
  • Secure, scalable, cloud-backed infrastructure

Useful Resources

analysis

Submit and retrieve sentiment analysis results

Submit text for sentiment analysis

Submits text for sentiment analysis.

Behavior is controlled by the X-WFT-Async-Mode header:

  • true (default): Processing is asynchronous. The API immediately returns a job ID. Use the job endpoints to monitor progress and retrieve results when complete.
  • false: Processing is synchronous. The API waits for the analysis to complete and returns the final sentiment analysis result in the same shape as GET /analyses/{id}.
Authorizations:
UserSecurity
header Parameters
X-WFT-Async-Mode
required
boolean
Example: true

Controls whether analysis is processed asynchronously (job-based) or synchronously.

  • true: Return current job metadata (jobId).
  • false: Block until analysis completes and return the final sentiment analysis result.
Request Body schema: application/json
required
feedId
string

Optional identifier to group related texts. Enables long-term tracking, trend analysis, and anomaly detection across all items sharing the same feedId.

text
required
string

The text to analyze. Must be valid UTF-8. Supports all languages.

Responses

Request samples

Content type
application/json
{
  • "text": "I absolutely love this product! It's the best thing ever!",
  • "feedId": "acme-corp-reviews"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "errors": [ ]
}

Retrieve completed sentiment analysis result

Fetches the final sentiment analysis result using the result ID obtained from a completed job. Includes overall sentiment, score, emotion breakdown, and rationale.

Authorizations:
UserSecurity
path Parameters
id
required
string <uuid>
Example: a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8

Result ID (UUID) from a SUCCEEDED sentiment analysis job

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [ ]
}

encryption

Provide encryption info

getPublicKeyPem

Authorizations:
UserSecurity

Responses

getCertificatePem

Authorizations:
UserSecurity

Responses

getEncryptionInfo

Authorizations:
UserSecurity

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "metadata": null
}

job

Monitor and manage asynchronous processing jobs

Get job processing status

Returns the current status of an asynchronous job (PENDING, PROCESSING, SUCCEEDED, FAILED, CANCELED). On success, also returns the result ID.

Authorizations:
UserSecurity
path Parameters
id
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

UUID of the job returned when the analysis was submitted

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ]
}