authenticated
campaigns

Agent Nps

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.

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)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

agent_module_idstring required

Query parameters

rangestring nullable

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.