Generated by API Evangelist
Written by API Evangelist tooling for S&P Global's API. It is a proposal applied on top of the contract, not a document S&P Global publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for LLM-ready Segments API
version: 1.0.0
extends: openapi/sp-global-segments-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/api/v1/segments/'].post
update:
x-apievangelist-phrasing:
intent: Get business or geographic segments for companies
effect: read
questions:
- How much revenue does a company make in each region?
- Can I compare line-of-business segments across several companies?
- Can I request year-to-date segment data?
instructions:
- text: Get segments for companies {company_ids}.
slots:
company_ids: requestBody.company_ids
- text: Get {segment_type} segments for companies {company_ids} from {start_year} to {end_year}.
slots:
segment_type: requestBody.segment_type
company_ids: requestBody.company_ids
start_year: requestBody.start_year
end_year: requestBody.end_year
- text: Pull the last {num_periods} {period_type} periods of segment data for {company_ids}.
slots:
num_periods: requestBody.num_periods
period_type: requestBody.period_type
company_ids: requestBody.company_ids
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/segments/{company_id}/{segment_type}/{period_type}/{start_year}/{end_year}/{start_quarter}/{end_quarter}'].get
update:
x-apievangelist-phrasing:
intent: Get one company's segments for a fixed period range
effect: read
questions:
- What were one company's geographic segments between two specific quarters?
- Can I fetch a single company's segment breakdown with years and quarters in the URL?
instructions:
- text: Get {segment_type} segments for company {company_id} as {period_type} from {start_year} Q{start_quarter} to {end_year} Q{end_quarter}.
slots:
segment_type: path.segment_type
company_id: path.company_id
period_type: path.period_type
start_year: path.start_year
start_quarter: path.start_quarter
end_year: path.end_year
end_quarter: path.end_quarter
- text: For single company {company_id}, show {period_type} {segment_type} segment results {start_year}-{start_quarter} through {end_year}-{end_quarter}.
slots:
company_id: path.company_id
period_type: path.period_type
segment_type: path.segment_type
start_year: path.start_year
start_quarter: path.start_quarter
end_year: path.end_year
end_quarter: path.end_quarter
method: generated
generated: '2026-10-01'
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.