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

# Voluum API

Voluum is a performance marketing tracker. The API allows managing campaigns, traffic sources, offers, and generating reports. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a session, create session with access key. Covers 6 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create a session
- Get report data
- Update traffic source
- Query and filter Voluum API records by parameters
- Monitor Voluum API operational status and events

## Use cases

### Marketing Operations

Use the Voluum API to perform marketing operations programmatically. The API provides 6 endpoints covering core functionality including create a session, create session with access key, get report data.

Example prompt: Call POST `/auth/session` to create a session

### Automated Auth Management

Automate auth operations by combining multiple Voluum API endpoints. Agents can create session with access key and then get report data in a single workflow.

Example prompt: Call POST `/auth/access/session` to create session with access key, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Voluum 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 tokens manually.

Example prompt: Search Jentic for 'create a session', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/session` | Create a session |
| POST | `/auth/access/session` | Create session with access key |
| GET | `/report` | Get report data |
| GET | `/report/live/clicks/{campaignId}` | Get live clicks for campaign |
| POST | `/campaign` | Create campaign |
| PUT | `/traffic-source/{trafficSourceId}` | Update traffic source |

## Key resources

- **Auth** — Operations for auth
- **Campaign** — Operations for campaign
- **Report** — Operations for report
- **Traffic Source** — Operations for traffic source

## 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:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/voluum.com/voluum/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 Voluum by hand means obtaining a session token from `/auth/session`, setting it in the cwauth-token header against api.voluum.com, and managing the report and campaign calls yourself. Through Jentic you install once, import Voluum from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Voluum puts the campaign id in the URL path (`/report/live/clicks/{campaignId}`), so a rule can pin your agent to reading live clicks for one campaign. You choose the operations it may call, so updates like the traffic-source PUT are not included unless you add them.
- **Credential handling:** Your Voluum session 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 'open a session' or 'pull a report', and Jentic returns the matching Voluum operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the Voluum API use?

The Voluum API uses an API key passed in the `cwauth-token` header. 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 create a session with the Voluum API?

Yes. Use the POST `/auth/session` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Voluum 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 create a session through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a session'. Jentic returns the matching Voluum API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Voluum API have?

The Voluum API exposes 6 endpoints covering auth, campaign, report operations.

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

Yes. Jentic One runs self-hosted, so your own rules decide which Voluum operations and credentials your agent may use. Because Voluum puts the campaign id in the URL path, you can pin the agent to reading live clicks for a single campaign through GET `/report/live/clicks/{campaignId}.` You choose exactly which operations are exposed, so write actions like the PUT `/traffic-source/{trafficSourceId}` update stay out of reach unless you add them.