GET/projects/{project_key}/nps-config

Fetch the NPS widget config

Public, unauthenticated. Returns the project's NPS trigger rules and per-locale copy overrides so the widget can self-configure on load. Returns the default disabled config when nothing has been saved for this project.

Base URLhttps://seggwat.com/api/v1

Parameters

project_keypathstring (uuid)required

Project key (UUID) from the dashboard.

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

Request

GET/projects/{project_key}/nps-config

curl \
  "https://seggwat.com/api/v1/projects/550e8400-e29b-41d4-a716-446655440000/nps-config"

Response

200application/json

{
  "cooldown_days": 90,
  "copy": {
    "locales": {}
  },
  "enabled": true,
  "sample_rate": 0.0,
  "triggers": {
    "event_names": [
      "onboarding_done",
      "purchase_completed"
    ],
    "show_after_seconds": 30,
    "url_patterns": [
      "/dashboard",
      "/billing/**"
    ]
  }
}

Navigation