canonical: https://jentic.com/apis/asknicely.asknice.ly/asknicely

# Asknicely Asknice Ly AskNicely API

Jentic publishes the only available OpenAPI specification for AskNicely API, keeping it validated and agent-ready. AskNicely is a customer experience platform focused on Net Promoter Score (NPS), CSAT, and CX feedback collection. The API exposes a single endpoint for retrieving NPS results over a configurable time window, with optional filtering by custom fields such as account or segment. Authentication uses an X-apikey header and the host subdomain is configurable per AskNicely tenant.

## For AI agents

Retrieve NPS scores from AskNicely over a specified time window, with optional filtering by custom field.

## Scope

Does not handle survey design, response collection, or campaign sending - use for retrieving NPS score data only.

## Capabilities

- Pull NPS results for a specified number of past days from an AskNicely tenant
- Filter NPS data by custom fields such as customer segment or product line
- Surface raw promoter, passive, and detractor counts for downstream reporting
- Drive a CX dashboard refresh with the latest NPS score
- Compare NPS scores across rolling time windows by issuing successive calls

## Use cases

### Daily NPS Reporting

Automate the daily refresh of an internal NPS dashboard by calling GET /getnps/{days} at a fixed interval. Agents can compare today's 30-day score against last week's and post a Slack summary, removing the manual export step that CX teams typically run from the AskNicely UI.

Example prompt: Call GET /getnps/30 on the asknicely tenant, capture the score and response counts, and post a daily summary to a Slack channel

### Segmented NPS Analysis

Use the optional custom-field filter on GET /getnps/{days} to break down NPS by customer segment, product line, or revenue band. Agents can build cohort-level NPS reports without exporting raw responses, supporting product and CS teams who need targeted views.

Example prompt: Call GET /getnps/90 filtered by the custom field 'plan=Enterprise' and return the segment NPS score

### AI Agent for CX Reporting

An agent integrated through Jentic can fetch NPS scores on demand, summarise trends in plain language, and answer ad-hoc questions like 'how is our enterprise NPS this quarter?' - without holding the AskNicely API key. Jentic stores the X-apikey value in its vault and injects it at execution time.

Example prompt: Through Jentic, retrieve the 30-day NPS score for the Enterprise segment and produce a one-paragraph summary for the CX leader

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /getnps/{days} | Get NPS score for the last N days |

## Key resources

- **NPS** — Retrieve NPS scores over a specified time window with optional custom-field filtering

## Why Jentic

- **Setup:** Wiring AskNicely by hand means resolving your tenant subdomain into the host and setting the X-apikey header on every NPS read. Through Jentic you install once, import the AskNicely API from the API Directory, store the key once, and your agent calls it while Jentic injects the header.
- **Permission scoping:** AskNicely exposes a single NPS read where {days} is a lookback window rather than a resource id, so limit the agent to the operation it needs, which is getting an NPS score. You choose the operations it may call, and no write operation exists to include.
- **Credential handling:** Your AskNicely API key is stored once, encrypted, by your own Jentic One instance and injected as the X-apikey header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get an NPS score', and Jentic returns the GET /getnps/{days} operation with its input schema so the agent does not need to know the tenant URL convention or the X-apikey header name in advance.

## Related APIs

- **SurveyMonkey** — SurveyMonkey is a general-purpose survey platform; AskNicely is purpose-built for NPS and CX programmes.
- **Typeform** — Typeform offers conversational surveys with strong UX customisation; AskNicely focuses on automated NPS workflows.
- **Survicate** — Survicate runs in-product micro-surveys including NPS, complementing or replacing AskNicely depending on programme scope.

## FAQ

### Why is there no official OpenAPI spec for AskNicely API?

AskNicely does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AskNicely API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the AskNicely API use?

The API uses an API key passed in the X-apikey header. The host is your AskNicely tenant subdomain (https://{subdomain}.asknice.ly/api/v1). Jentic stores the key in its vault and injects it at execution time so it never enters the agent's context.

### Can I get an NPS score for the last N days?

Yes. GET /getnps/{days} returns the NPS score over the specified number of days. The path parameter sets the time window - for example /getnps/30 returns the rolling 30-day score.

### Can I filter AskNicely NPS results by custom field?

Yes. The GET /getnps/{days} endpoint accepts optional query parameters that filter responses by custom fields configured in the AskNicely tenant - for example a customer segment, plan, or account identifier.

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

The OpenAPI specification does not publish explicit rate limits. The endpoint is read-only, so cache the response if it is being used to refresh a dashboard at high frequency. Implement exponential backoff on HTTP 429 responses to stay within tenant quotas.

### How do I retrieve NPS through Jentic?

Search Jentic for 'get an AskNicely NPS score' - the GET /getnps/{days} operation will be returned. Load the schema, supply the days value and any custom-field filters, and execute. Jentic handles the X-apikey header and tenant subdomain.

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

Yes. Jentic One is self-hosted, so your own rules decide which operations and credentials the agent may use. This API exposes only a single read that returns an NPS score over a lookback window, and since there is no write operation, you can grant the agent just that one read and nothing else.