---
title: "Agent Nps"
method: GET
path: "/campaigns/{agent_module_id}/nps"
tags: ["authenticated", "campaigns"]
---

# Agent Nps

`GET /campaigns/{agent_module_id}/nps`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/campaigns/{agent_module_id}/nps`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Net Promoter Score for a Sunny agent's collected reviews, current vs prior.

Sunny-only: any other roster has no recorded NPS, so the score is null.
``range`` mirrors the detail endpoint (today / 7d / 30d) and the prior
window is the equally-sized period immediately before it.

## Path parameters

- `agent_module_id` string, required

## Query parameters

- `range` string, nullable

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)