Generated by API Evangelist
Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Gainsight CS Customer Goals Metrics API
version: 1.0.0
extends: openapi/gainsight-metrics-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/goals/{goalId}/metrics'].get
update:
x-apievangelist-phrasing:
intent: List a goal's metrics
effect: read
questions:
- How is progress on a customer goal being measured?
- Which metrics and target values are attached to a goal?
instructions:
- text: List the metrics on goal {goalId}.
slots:
goalId: path.goalId
- text: Show current versus target values for goal {goalId}.
slots:
goalId: path.goalId
method: generated
generated: '2026-09-26'
- target: $.paths['/goals/{goalId}/metrics'].post
update:
x-apievangelist-phrasing:
intent: Add a metric to a goal
effect: write
questions:
- Can I add a measurable target, like adoption rate, to a customer goal?
- How do I track a metric's current value against its target?
instructions:
- text: Add metric {Name} with target {TargetValue} to goal {goalId}.
slots:
Name: requestBody.Name
TargetValue: requestBody.TargetValue
goalId: path.goalId
- text: Attach metric {Name} to goal {goalId}, currently {CurrentValue} of {TargetValue} {Unit}.
slots:
Name: requestBody.Name
goalId: path.goalId
CurrentValue: requestBody.CurrentValue
TargetValue: requestBody.TargetValue
Unit: requestBody.Unit
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.