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

# Slickstream Engagement API

API for retrieving site summary data and content analytics from Slickstream engagement suite. The API exposes 2 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get site summary data, get content analytics. Covers 2 operations with apiKey authentication.

## Scope

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

## Capabilities

- Get site summary data
- Manage analytics data programmatically
- Integrate Slickstream Engagement API into automated workflows
- Query and filter Slickstream Engagement API records by parameters
- Monitor Slickstream Engagement API operational status and events

## Use cases

### Analytics Operations

Use the Slickstream Engagement API to perform analytics operations programmatically. The API provides 2 endpoints covering core functionality including get site summary data, get content analytics.

Example prompt: Call GET `/example/{siteCode}/v1/site` to get site summary data

### Data Retrieval and Monitoring

Query Slickstream Engagement API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Slickstream Engagement API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Slickstream Engagement 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 'get site summary data', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/example/{siteCode}/v1/site` | Get site summary data |
| GET | `/example/{siteCode}/v1/site-content-analytics` | Get content analytics |

## Key resources

- **Analytics** — Operations related to Analytics
- **Site** — Operations related to Site

## 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:** 47 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/slickstream.com/slickstream/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 Slickstream Engagement API by hand means passing your apiKey as a query parameter to api.slickstream.com and handling the site and content analytics reads yourself. Through Jentic you install once, import Slickstream from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Slickstream puts the site code in the URL path (`/example/{siteCode}/v1/site`), so a rule can pin your agent to one site. You choose the operations it may call, so if you only grant the site read, the content analytics read is not included unless you add it.
- **Credential handling:** Your Slickstream API key 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 'get site details' or 'read content analytics for a site', and Jentic returns the matching Slickstream operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Slickstream Engagement API use?

The Slickstream Engagement API uses an API key passed in the `apiKey` query. 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 get site summary data with the Slickstream Engagement API?

Yes. Use the GET `/example/{siteCode}/v1/site` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Slickstream Engagement 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 get site summary data through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get site summary data'. Jentic returns the matching Slickstream Engagement API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Slickstream Engagement API have?

The Slickstream Engagement API exposes 2 endpoints covering analytics, site operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Slickstream operations and credentials the agent may use. Slickstream puts the site code in the URL path, such as `/example/{siteCode}/v1/site`, so a rule can pin the agent to a single site. You also choose the operations it may call, so granting the site summary read (GET `/example/{siteCode}/v1/site`) does not include the content analytics read (GET `/example/{siteCode}/v1/site-content-analytics`) unless you add it.