# Gainsight PX REST API

**Canonical:** https://apis.io/apis/gainsight/gainsight-px-rest-api/  
**Provider:** Gainsight — https://apis.io/providers/gainsight/  
**Base URL:** https://api.aptrinsic.com/v1  
**Documentation:** https://px-apidocs.gainsight.com/

Gainsight PX REST API is one of 32 APIs that [Gainsight](https://apis.io/providers/gainsight/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Product Experience, Product Analytics, User Engagement, Customer Success, and Event. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

The Gainsight PX REST API — the one Gainsight surface with a published machine-readable contract. Swagger 2.0, 59 paths, 74 operations, 93 definitions, covering users, accounts, custom events, engagements, features, segments, survey responses and the product-analytics event streams (page view, session, identify, form submit, feature match, segment match, email, engagement view). Harvested verbatim from Gainsight's own documentation host on 2026-09-17.

## Operations (60 of 74)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/accounts` | Get accounts |
| POST | `/v1/accounts` | Create account |
| PUT | `/v1/accounts/update` | Update account (accountId passed via request body) |
| GET | `/v1/accounts/{accountId}` | Get account |
| PUT | `/v1/accounts/{accountId}` | Update account |
| DELETE | `/v1/accounts/{accountId}` | Delete account |
| GET | `/v1/admin/model/{type}/attributes` | Get Attributes |
| GET | `/v1/admin/monitoring/engagement_collisions` | Get engagement collisions |
| GET | `/v1/admin/monitoring/engagement_error_details/{engagementId}` | Get engagement error details |
| GET | `/v1/admin/monitoring/engagement_errors` | Get engagement errors summary |
| GET | `/v1/admin/monitoring/integrations` | Get integration statuses |
| GET | `/v1/admin/subscription` | Get Subscription detail |
| GET | `/v1/admin/subscription/users/notSeenAfter` | Get Subscription users |
| GET | `/v1/articles` | Get Articles |
| GET | `/v1/articles/{articleId}` | Get Article |
| GET | `/v1/engagement` | Get engagements |
| PUT | `/v1/engagement/env` | Set engagement environment |
| PUT | `/v1/engagement/envs` | Set engagement environments |
| GET | `/v1/engagement/extended` | Get engagements with list of custom events from rules |
| GET | `/v1/engagement/metadata/survey` | getEngagementViewEvents |
| PUT | `/v1/engagement/state` | Set engagement state |
| GET | `/v1/engagement/{engagementId}` | Get engagement |
| DELETE | `/v1/engagement/{engagementId}` | deleteEngagement |
| GET | `/v1/events/custom` | Get Custom events |
| POST | `/v1/events/custom` | Create custom event |
| GET | `/v1/events/email` | Get Email events |
| GET | `/v1/events/engagementView` | Get Engagement View events |
| GET | `/v1/events/feature_match` | Get feature match events |
| GET | `/v1/events/formSubmit` | Get formSubmit events |
| GET | `/v1/events/identify` | Get Identify events |
| GET | `/v1/events/lead` | Get Lead events |
| GET | `/v1/events/pageView` | Get Page View events |
| GET | `/v1/events/segment_match` | Get segment match events |
| GET | `/v1/events/session` | Get Session events |
| POST | `/v1/external_segment/metadata` | createExternalSegment |
| PUT | `/v1/external_segment/metadata` | updateExternalSegment |
| POST | `/v1/external_segment/update_membership` | Update External Segment membership |
| GET | `/v1/feature` | Get features |
| GET | `/v1/feature/adoption/{featureId}` | Get feature adoption statistics |
| POST | `/v1/feature/backfill/{featureId}` | Request backfill for feature |
| GET | `/v1/feature/{featureId}` | Get feature |
| PUT | `/v1/feature/{featureId}` | Update feature |
| GET | `/v1/kcbot` | Get KC Bots |
| PUT | `/v1/kcbot/state` | Set KC state |
| GET | `/v1/kcbot/{kcId}` | Get KC Bot |
| GET | `/v1/localization/export/articles` | export XLIFF for articles |
| GET | `/v1/localization/export/content` | export XLIFF |
| GET | `/v1/localization/export/engagement` | export XLIFF |
| GET | `/v1/localization/export/kcbot` | export XLIFF |
| POST | `/v1/localization/import/articles` | import XLIFF |
| POST | `/v1/localization/import/content` | import XLIFF |
| POST | `/v1/localization/import/engagement` | import XLIFF |
| POST | `/v1/localization/import/kcbot` | import XLIFF |
| GET | `/v1/segment` | Get segments |
| GET | `/v1/segment/{segmentId}` | Get segment |
| GET | `/v1/survey/responses` | Get Survey responses |
| POST | `/v1/user/preferences` | Get user preferences (identifyId passed via request body) |
| PUT | `/v1/user/preferences` | Update user preferences (identifyId passed via request body) |
| GET | `/v1/user/preferences/{identifyId}` | Get user preferences |
| PUT | `/v1/user/preferences/{identifyId}` | Update user preferences |

…and 14 more operations. They are listed in full on the page.

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/openapi/gainsight-px-rest-api-openapi.yml
- **OpenAPI** — https://px-apidocs.gainsight.com/source.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/overlays/gainsight-px-rest-api-overlay.yaml
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/llms/gainsight-px-llms.txt
- **APIReference** — https://px-apidocs.gainsight.com/
- **Documentation** — https://support.gainsight.com/PX/API_for_Developers
- **Authentication** — https://support.gainsight.com/PX/API_for_Developers/02About/Authentication
- **API Keys** — https://support.gainsight.com/PX/API_for_Developers/02About/API_Keys
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/data-model/gainsight-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/errors/gainsight-problem-types.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/rate-limits/gainsight-rate-limits.yml
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/skills/_index.yml

## Other Gainsight APIs (12)

- [Gainsight Accounts API](https://apis.io/apis/gainsight/gainsight-accounts-api/)
- [Gainsight Activities API](https://apis.io/apis/gainsight/gainsight-activities-api/)
- [Gainsight Activity Types API](https://apis.io/apis/gainsight/gainsight-activity-types-api/)
- [Gainsight Companies API](https://apis.io/apis/gainsight/gainsight-companies-api/)
- [Gainsight Company Team API](https://apis.io/apis/gainsight/gainsight-company-team-api/)
- [Gainsight Configuration API](https://apis.io/apis/gainsight/gainsight-configuration-api/)
- [Gainsight CTA Configuration API](https://apis.io/apis/gainsight/gainsight-cta-configuration-api/)
- [Gainsight CTAs API](https://apis.io/apis/gainsight/gainsight-ctas-api/)
- [Gainsight Custom Events API](https://apis.io/apis/gainsight/gainsight-custom-events-api/)
- [Gainsight Custom Objects API](https://apis.io/apis/gainsight/gainsight-custom-objects-api/)
- [Gainsight Engagements API](https://apis.io/apis/gainsight/gainsight-engagements-api/)
- [Gainsight Events API](https://apis.io/apis/gainsight/gainsight-events-api/)

## Tags

Product Experience, Product Analytics, User Engagement, Customer Success, Event

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gainsight/gainsight-px-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gainsight/.