Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Statistics API

6 actions 6 updates phrasing extends openapi/strivacity-statistics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/statistics/ActiveAccounts'].get
$.paths['/admin/api/v1/statistics/ConnectorJob'].get
$.paths['/admin/api/v1/statistics/ConnectorUptime'].get
$.paths['/admin/api/v1/statistics/ConsentAcceptance'].get
$.paths['/admin/api/v1/statistics/{name}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Statistics API
  version: 1.0.0
extends: openapi/strivacity-statistics-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: 5
- target: $.paths['/admin/api/v1/statistics/ActiveAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get active account statistics
      effect: read
      questions:
      - How many active accounts did we have each month?
      - Can I break down active users by period and time zone?
      instructions:
      - text: Get active account statistics since {start}.
        slots:
          start: query.startDate
      - text: Show active accounts from {start} to {end} by {period}.
        slots:
          start: query.startDate
          end: query.endDate
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/statistics/ConnectorJob'].get
  update:
    x-apievangelist-phrasing:
      intent: Get connector job statistics
      effect: read
      questions:
      - How are my inbound connector jobs performing?
      - Can I filter connector job stats by status?
      instructions:
      - text: Get connector job statistics for identity store {store}.
        slots:
          store: query.identityStore
      - text: Show connector jobs with status {status} in {store}.
        slots:
          status: query.status
          store: query.identityStore
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/statistics/ConnectorUptime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get connector uptime statistics
      effect: read
      questions:
      - What was the uptime of my identity store connectors?
      - Can I see connector availability over a date range?
      instructions:
      - text: Get connector uptime for identity store {store} since {start}.
        slots:
          store: query.identityStore
          start: query.startDate
      - text: Show connector uptime in {store} from {start} to {end}.
        slots:
          store: query.identityStore
          start: query.startDate
          end: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/statistics/ConsentAcceptance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get consent acceptance statistics
      effect: read
      questions:
      - What share of users accept our consents?
      - Can I see consent acceptance per application?
      instructions:
      - text: Get consent acceptance statistics for application {app}.
        slots:
          app: query.application
      - text: Show consent acceptance rates from {start} to {end}.
        slots:
          start: query.startDate
          end: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/statistics/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Query a named statistic
      effect: read
      questions:
      - Which statistics can I query by name, such as flow runs or screen time?
      - Can I get event hook execution time at a given percentile?
      - Is it possible to group a named statistic by application or organization?
      instructions:
      - text: Query the {name} statistic from {start} to {end}.
        slots:
          name: path.name
          start: query.startDate
          end: query.endDate
      - text: Get the {name} statistic grouped by {group}.
        slots:
          name: path.name
          group: query.groupBy
      method: generated
      generated: '2026-10-01'