What does the API do?

 

It performs real‑time sentiment analysis on submitted text, returning positive/negative/neutral labels with confidence scores, and can group results by feed ID to track trends and anomalies over time.​

​

How do feeds work?

 

[Planned] You will be able to include a feedId with each request to aggregate metrics for that stream. The service will maintain rolling stats like average sentiment, variance, trend direction, and anomaly flags per feed.​

 

Can it detect anomalies or spikes?

​

[Planned] The API will flag unusual sentiment movements within a feed, such as sudden spikes or irregular tone shifts, so you can alert or investigate.​

​

Does it support batch processing?

 

[Planned] You will be able to submit multiple texts in a single request and receive per‑item sentiment results and errors, which simplifies bulk ingestion.​

 

What metrics are available for monitoring feeds?

​

[Planned] Per‑feed stats will include average sentiment, variance, sample counts, trend direction (improving/worsening/stable), and anomaly indicators over configurable windows.​

 

Can I query by time window?

​

[Planned] You will be able to use parameters like from/to or preset windows (last hour/day/week) to compute metrics and trends for specific periods.​

 

Is multilingual text supported?

​

Yes. Language auto‑detection routes content to language‑appropriate models.

​

What security/authentication is used?

 

[Planned] Access will be via API key on secure REST endpoints, with optional IP allowlisting and idempotency keys to avoid double‑counting on retries.​

 

What rate limiting applies?

 

[Planned] Requests will be rate‑limited to ensure stability; responses include headers to help you back off or retry safely using idempotent keys.​

 

Are webhooks available?

 

[[Planned] You will be able to configure webhooks for asynchronous processing and notifications, including anomaly events or threshold breaches.​

 

How are errors returned?

 

Structured error responses include codes, messages, and request IDs for traceability; retries should use idempotency keys.​

 

Can I export data?

 

[Planned] You will be able to export feed summaries and aggregates as JSON or CSV for downstream BI/reporting and archival.​