Operations 7
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
Ask an LLM
“What attributes does the user or account model have in PX?”
“Can I see the custom attribute definitions for a model type?”
Tell an agent
Get the model attributes for type {type}.
List every attribute defined on the {type} model.
GET
/v1/admin/monitoring/engagement_collisions
Report engagement collisions · Get engagement collisions
#
Ask an LLM
“Which engagements collided with each other in the last month?”
“Is there a limit on how long a date range I can check for engagement collisions?”
Tell an agent
Show engagement collisions between {dateRangeStart} and {dateRangeEnd}.
List collisions for product {propertyKey} in that window.
GET
/v1/admin/monitoring/engagement_error_details/{engagementId}
Get error details for an engagement · Get engagement error details
#
Ask an LLM
“Why is one particular engagement failing, broken down by browser?”
“Can I see each individual error an engagement threw?”
Tell an agent
Get error details for engagement {engagementId}, grouped by browser.
Show errors for engagement {engagementId} from {dateRangeStart} to {dateRangeEnd}.
GET
/v1/admin/monitoring/engagement_errors
Summarize engagements with errors · Get engagement errors summary
#
Ask an LLM
“Which engagements had errors this week?”
“Can I get one summary row per engagement that has failed?”
Tell an agent
Summarize engagement errors from {dateRangeStart} to {dateRangeEnd}.
List failing engagements for product key {propertyKey}.
Ask an LLM
“Are my PX integrations healthy right now?”
“What is the current status of each configured integration?”
Tell an agent
Show the status of every configured integration.
Check whether any integration is currently failing.
Ask an LLM
“What are the details of my current PX subscription?”
“Where can I see the settings of the subscription my key belongs to?”
Tell an agent
Get the detail of my current subscription.
Show the subscription this API key belongs to.
GET
/v1/admin/subscription/users/notSeenAfter
Find users not seen since a date · Get Subscription users
#
Ask an LLM
“Which users haven't been seen in the product since a given date?”
“Can I list inactive subscription users for cleanup?”
Tell an agent
List subscription users not seen after {notSeenAfterTimestamp}.
Find users inactive since {notSeenAfterTimestamp}, {pageSize} per page.
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://artifacts.apis.io/gainsight/rate-limits/gainsight-rate-limits.yml
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-attribute-metadata-schema.json
JSONSchema
https://artifacts.apis.io/gainsight/json-schema/gainsight-engagement-error-summary-page-schema.json
Other Resources
LLMsTxt
https://artifacts.apis.io/gainsight/llms/gainsight-px-llms.txt
API Keys
https://support.gainsight.com/PX/API_for_Developers/02About/API_Keys
DataModel
https://artifacts.apis.io/gainsight/data-model/gainsight-data-model.yml
ErrorCatalog
https://artifacts.apis.io/gainsight/errors/gainsight-problem-types.yml