Gainsight

Gainsight UserPreferences V2 API

User Preferences Version 2 API. Version 2 has support for new setting called 'trackEmailAnalytics' which is to specify whether to track email analytics or not for the given user.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/user/preferences Read v2 preferences with the user ID in the body · Get user preferences #
Ask an LLM
“Is there a v2 POST lookup that includes email analytics preferences?”
“Where can I read trackEmailAnalytics for a user with an awkward ID?”
Tell an agent
Look up v2 preferences for user {identifyId}, passing the ID in the body.
Fetch email analytics consent of body-identified user {identifyId}.
PUT /v2/user/preferences Update v2 preferences with the user ID in the body · Update user preferences, this version of API can take 'trackEmailAnalytics' and… #
Ask an LLM
“How do I set email analytics tracking for a user whose ID can't go in the URL?”
“Can the v2 body-based update change trackEmailAnalytics?”
Tell an agent
Set email analytics tracking to {trackEmailAnalytics} for user {identifyId}, ID in body.
Update v2 preferences of body-identified user {identifyId}: surveys {surveys}.
GET /v2/user/preferences/{identifyId} Get a user's v2 preferences · Get user preferences #
Ask an LLM
“Has a user allowed email analytics tracking?”
“What does the v2 preferences read return beyond the v1 version?”
Tell an agent
Get v2 preferences for user {identifyId}.
Show whether user {identifyId} permits email analytics.
PUT /v2/user/preferences/{identifyId} Update a user's v2 preferences · Update user preferences, this version of API can take 'trackEmailAnalytics'… #
Ask an LLM
“Can I turn off email analytics for one user?”
“Can the v2 update change just the trackEmailAnalytics flag?”
Tell an agent
Set trackEmailAnalytics to {trackEmailAnalytics} for user {identifyId}.
Update v2 preferences for {identifyId}: track usage {trackUsage}.

Documentation

📖
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
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/rate-limits/gainsight-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/openapi/gainsight-userpreferences-v2-api-openapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/gainsight/refs/heads/main/llms/gainsight-px-llms.txt
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gainsight-userpreferences-v2-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gainsight-userpreferences-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Gainsight PX API provides a programmatic (server-based) method to access the users, accounts, and events that have been captured by the Gainsight PX subscription.
  version: 0.1.6
  title: Gainsight PX REST UserPreferences V2 API
  contact:
    name: Gainsight PX
    url: https://www.gainsight.com/product-experience/
    email: pxsupport@gainsight.com
  license:
    name: internal
servers:
- url: https://api.aptrinsic.com/
tags:
- name: UserPreferences V2
  description: User Preferences Version 2 API. Version 2 has support for new setting called 'trackEmailAnalytics' which is to specify whether to track email analytics or not for the given user.
paths:
  /v2/user/preferences:
    post:
      tags:
      - UserPreferences V2
      summary: Get user preferences
      description: If the field is not set - return null.
      operationId: getUserPreferencesUsingPOST_1
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserPreferencesV2'
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIdentifyId'
        description: User identify id
        required: true
    put:
      tags:
      - UserPreferences V2
      summary: Update user preferences, this version of API can take 'trackEmailAnalytics' and…
      description: 'The fields are optional so it’s possible to provide only those that need to be updated.


        If the user had preferences - override only the provided fields.


        Valid field values: true, false, null.


        Note: null value won’t override any other.'
      operationId: updateUserPreferencesUsingPUT_3
      responses:
        '204':
          description: Updated
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserPreferencesV2'
        description: User preferences
        required: true
  /v2/user/preferences/{identifyId}:
    get:
      tags:
      - UserPreferences V2
      summary: Get user preferences
      description: If the field is not set - return null.
      operationId: getUserPreferencesUsingGET_1
      parameters:
      - name: identifyId
        in: path
        description: User identify id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserPreferencesV2'
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
    put:
      tags:
      - UserPreferences V2
      summary: Update user preferences, this version of API can take 'trackEmailAnalytics'…
      description: 'The fields are optional so it’s possible to provide only those that need to be updated.


        If the user had preferences - override only the provided fields.


        Valid field values: true, false, null.


        Note: null value won’t override any other.'
      operationId: updateUserPreferencesUsingPUT_2
      parameters:
      - name: identifyId
        in: path
        description: User identify id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Updated
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '403':
          description: Access denied
        '404':
          description: User not found by id
        '429':
          description: Rate limit exceeded
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesV2'
        description: User preferences
        required: true
components:
  schemas:
    UpdateUserPreferencesV2:
      type: object
      required:
      - identifyId
      properties:
        guidedTours:
          type: boolean
        identifyId:
          type: string
          readOnly: true
        onboardingBot:
          type: boolean
        productUpdates:
          type: boolean
        surveys:
          type: boolean
        trackEmailAnalytics:
          type: boolean
        trackUsage:
          type: boolean
      title: UpdateUserPreferencesV2
      description: Update user preferences V2
    UserIdentifyId:
      type: object
      required:
      - identifyId
      properties:
        identifyId:
          type: string
      title: UserIdentifyId
      description: User object
    UserPreferencesV2:
      type: object
      properties:
        guidedTours:
          type: boolean
        onboardingBot:
          type: boolean
        productUpdates:
          type: boolean
        surveys:
          type: boolean
        trackEmailAnalytics:
          type: boolean
        trackUsage:
          type: boolean
      title: UserPreferencesV2
      description: User preferences V2
  securitySchemes:
    X-APTRINSIC-API-KEY:
      type: apiKey
      name: Aptrinsic API Key
      in: header