canonical: https://jentic.com/apis/reveldigital.com/reveldigital

# Revel Digital REST API

REST API for managing digital signage devices, media, playlists, schedules, templates, analytics, alerts, data tables, and user accounts in the Revel Digital platform. The API exposes 101 endpoints secured with apiKey, oauth2 authentication.

## For AI agents

Programmatically gets account details., updates an account.. Covers 101 operations with apiKey, oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Gets account details.
- Updates an account.
- Returns AdHawk dataset based on the provided post parameters.
This is a legacy
- Query and filter Revel Digital REST API records by parameters
- Monitor Revel Digital REST API operational status and events

## Use cases

### Developer Tools Operations

Use the Revel Digital REST API to perform developer tools operations programmatically. The API provides 101 endpoints covering core functionality including gets account details., updates an account., gets organizations..

Example prompt: Call GET /account to gets account details.

### Automated Account Management

Automate account operations by combining multiple Revel Digital REST API endpoints. Agents can updates an account. and then gets organizations. in a single workflow.

Example prompt: Call PUT /account to updates an account., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Revel Digital REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, oauth2 tokens manually.

Example prompt: Search Jentic for 'gets account details.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/account` | Gets account details. |
| PUT | `/account` | Updates an account. |
| GET | `/account/organizations` | Gets organizations. |
| GET | `/account/auditevents` | Gets audit events for the account. |
| GET | `/account/auditevents/{eventId}` | Gets a single audit event by ID. |
| POST | `/adhawk/dataset` | Returns AdHawk dataset based on the provided post parameters. This is a legacy |
| GET | `/adhawk/playlogs` | Gets play logs for the account. |
| GET | `/adhawk/pinglogs` | Gets ping/heartbeat logs for the account. |

## Key resources

- **Account** — Operations related to Account
- **AdHawk** — Operations related to AdHawk
- **Alerts** — Operations related to Alerts
- **DataTables** — Operations related to DataTables
- **Devices** — Operations related to Devices

## 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:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 92 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 84 / 100
  - Security: 52 / 100
  - AI Discoverability: 56 / 100
- **View full report:** https://jentic.com/apis/reveldigital.com/reveldigital/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 Revel Digital REST API by hand means handling two auth paths, an X-RevelDigital-ApiKey header and an OAuth 2.0 authorization-code flow, targeting the api.reveldigital.com host, and managing account and audit-event calls yourself. Through Jentic you install once, import Revel Digital REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Revel Digital REST API puts the event id in the URL path (`/account/auditevents/{eventId}`), so a rule can pin your agent to one audit event: it can read that event and nothing else. You choose the operations it may call, so writes like updating the account are not included unless you add them.
- **Credential handling:** Your Revel Digital REST API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get account details' or 'read an audit event', and Jentic returns the matching Revel Digital REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Revel Digital REST API use?

The Revel Digital REST API uses apiKey, oauth2 authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I gets account details. with the Revel Digital REST API?

Yes. Use the GET /account endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Revel Digital REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I gets account details. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'gets account details.'. Jentic returns the matching Revel Digital REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Revel Digital REST API have?

The Revel Digital REST API exposes 101 endpoints covering account, adhawk, alerts operations.

### Can I limit what my agent is allowed to do with the Revel Digital REST API?

Yes. Because you self-host Jentic One, your own rules decide which Revel Digital REST API operations and credentials the agent may use. You can restrict it to read-only calls such as GET /account or GET `/account/auditevents` while leaving out writes like PUT /account that updates the account. Since the event id sits in the URL path at `/account/auditevents/{eventId}`, a rule can even pin the agent to a single audit event so it reads that one record and nothing else.
