canonical: https://jentic.com/apis/cheers.tech/cheers

# Cheers Tech Cheers Public API (legacy snapshot)

The Cheers API is a legacy public snapshot that reads a workspace's engagement data: organizations and their connections, the cards (badges) tied to them, the taps those cards record, the reviews collected, and the links and link interactions behind them. The cards endpoint also updates a badge. It returns the data a reporting or reputation dashboard needs, keyed to the bearer token's workspace, while the current contract lives behind the vendor's own documentation.

## For AI agents

Read a workspace's organizations, cards (badges), taps, reviews, links, and link interactions, and update a card, using a bearer token. A legacy public snapshot for reporting on tap-card engagement and reviews.

## Scope

Does not send review requests, run ad campaigns, or program NFC cards. Use for reading Cheers workspace engagement, reviews, and link data only.

## Capabilities

- List the organizations and organization connections in a workspace
- List the cards (badges) tied to a workspace and update a card
- Read the taps a card has recorded
- Pull the reviews collected for a workspace
- Read the links and the interactions logged against them

## Use cases

### Agent-Built Engagement Reports

An AI agent reads a Cheers workspace's taps, reviews, links, and link interactions through Jentic and assembles an engagement report without a human exporting data by hand. Every call carries the workspace bearer token, so the agent only sees that workspace, and a rule can keep it on the read operations. The agent discovers each read by intent and calls it directly.

Example prompt: Read the taps, reviews, and link interactions for the workspace and summarize this week's engagement.

### Review and Reputation Dashboard

A dashboard pulls the reviews a workspace has collected along with the cards (badges) and organizations they belong to, giving a reputation view per organization. Cheers returns reviews keyed to the bearer token's workspace, and the cards endpoint can update a badge's details. This drives a read-first reputation surface over the snapshot.

Example prompt: List the organizations, pull their reviews, and rank organizations by review count.

### Tap and Link Interaction Analytics

An analytics flow reads taps from NFC cards and the interactions logged against shared links to measure how often each converts. Cheers exposes taps, links, and link interactions as separate reads keyed to the workspace. Teams use this to see which cards and links drive the most engagement.

Example prompt: Pull link interactions and taps, then compute the interaction rate per link for the workspace.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/organizations` | List organizations |
| GET | `/cards` | List cards (badges) |
| PATCH | `/cards` | Update a card (badge) |
| GET | `/taps` | List taps |
| GET | `/reviews` | List reviews |
| GET | `/links` | List links |
| GET | `/link_interactions` | List link interactions |

## Key resources

- **Organizations** — List the organizations in a workspace and their connections
- **Cards** — List the cards (badges) tied to a workspace and update a card
- **Taps** — The taps each card has recorded
- **Reviews** — The reviews collected for a workspace
- **Links** — The links and the interactions logged against them

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 61 / 100
- **View full report:** https://jentic.com/apis/cheers.tech/cheers/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Cheers API by hand means sending a bearer token on every read and keeping to the one workspace that token belongs to, against a legacy snapshot whose current contract lives elsewhere. Through Jentic you install once, import Cheers from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Cheers is almost entirely read endpoints with a single card update, so a rule can bound your agent to the reads it needs, such as taps, reviews, and link interactions. You choose the operations it may call, so updating a card is not included unless you add it.
- **Credential handling:** Your Cheers token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'read the reviews for my workspace', and Jentic returns the matching Cheers operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Mixpanel** — Product analytics for events, funnels, and retention.
- **Amplitude** — Behavioral product analytics across user journeys.
- **SurveyMonkey** — Surveys and feedback collection to pair with engagement data.

## FAQ

### What authentication does the Cheers API use?

The Cheers API authenticates with a bearer token (an API key) in the Authorization header, per its OpenAPI spec, and every read is scoped to that token's workspace. This is a legacy public snapshot, so check the vendor's current documentation for any newer auth details. Through Jentic the token is stored encrypted by your own Jentic One instance and injected only at call time.

### Can I read taps, reviews, and links with the Cheers API?

Yes. The API lists a workspace's organizations and connections, its cards (badges) and the taps they record, the reviews collected, and the links with their logged interactions. The cards endpoint can also update a badge's details.

### What are the rate limits for the Cheers API?

The OpenAPI spec does not specify rate limits for the Cheers API, and because it is a legacy snapshot the current limits live with the vendor. Check the documentation at https://app.cheers.tech/docs for current limits.

### Can I limit what my agent is allowed to do with the Cheers API?

Yes. Write a rule that allows only the read operations, such as listing taps, reviews, and links, so the agent reports on engagement but cannot update a card. Every call carries your workspace token, is logged, and the agent never sees the token itself.

### Is there a Cheers MCP server?

You don't need an MCP server to give your agent the Cheers API. Jentic connects it directly from the API Directory: import it, store your workspace token once, and your agent calls the tap, review, and link reads. You skip loading another server's tool definitions into the agent's context.

### How do I read Cheers engagement data through Jentic?

Add the Cheers API from the Jentic API Directory and store your workspace token once. Your agent then searches by intent such as 'read the reviews for my workspace' and Jentic returns the matching operation with its input schema, so it can pull the reviews, taps, and link interactions. To run it on your own infrastructure, install Jentic One from its GitHub repo.
