Gremlin reports API

Get users, clients, and attacks summaries

Operations 21

GET /reports/attacks Loads the Attacks Summary for the specified time period. #
GET /reports/clients Loads the Client Summary for the specified time period. #
GET /reports/companies Loads the Company Summary for the specified month. #
GET /reports/companies/pdf Loads the Company Summary PDF for the specified time frame. #
GET /reports/companies/reliability-management Loads the Company Reliability Management Report for the specified time window defaulting to a week. #
GET /reports/companies/reliability-management/services Loads the company service list and reliability trend for each service for the specified time window defaulting to a month. #
GET /reports/companies/reliability-management/grouped Loads the Company Reliability Management Report grouped by query param value of groupBy - defaults to TEAM. #
GET /reports/companies/trends Returns the Risk and Score trends for your company across all associated services #
GET /reports/team/detected-risk/trend Returns the trend of risks across all services for a given team #
GET /reports/team/reliability-report #
GET /reports/team/reliability-report/pdf Loads the team reliability report PDF for the specified time frame. #
GET /reports/services/reliability-management/reliability-report-trend Loads the Reliability report trend for all the services of the team for the specified time period defaulting to 1 months and 4 data points #
GET /reports/services/{serviceId}/reliability-management/reliability-report-trend Loads the Reliability report trend for the service for the specified time period defaulting to 1 months and 4 data points #
GET /reports/team/reliability-report/trend Returns the trend of Reliability Scores across all services for a given team #
GET /reports/team/detected-risks-report Loads latest risk evaluation for each eligible service for the team #
GET /reports/team/detected-risks-report/pdf Loads the team risk report PDF for the specified time frame. #
GET /reports/team/trends Returns the trend of Reliability Scores across all services for a given team #
GET /reports/pricing Loads the pricing usage for the specified dates and tracking period. #
GET /reports/teams This functionality has moved to GET /reports/teams/paged.Loads the Team Summary for the specified month. #
GET /reports/teams/paged Loads the Team Summary for the specified month. #
GET /reports/users Loads the User Summary for the specified time period. #

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/gremlin-reports-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.

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

OpenAPI Specification

gremlin-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gremlin agents Reports API
  description: The API for interacting with the Gremlin Failure-as-a-Service platform
  termsOfService: https://www.gremlin.com/terms_of_service_2017_03_24
  contact:
    name: Gremlin Support
    email: support@gremlin.com
  license:
    name: Gremlin License
    url: https://www.gremlin.com/license_2017_03_24
  version: '1.0'
servers:
- url: https://api.gremlin.com/v1
  description: Gremlin API v1
tags:
- name: reports
  description: Get users, clients, and attacks summaries
paths:
  /reports/attacks:
    get:
      tags:
      - reports
      summary: Loads the Attacks Summary for the specified time period.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: attackSummary
      parameters:
      - name: teamId
        in: query
        description: team identifier associated with the requester's team
        required: true
        schema:
          type: string
        example: '2026-05-01'
      - name: start
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: end
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: period
        in: query
        required: true
        schema:
          type: string
          enum:
          - MONTHS
          - WEEKS
          - DAYS
      responses:
        default:
          description: default response
          content:
            application/json: {}
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
  /reports/clients:
    get:
      tags:
      - reports
      summary: Loads the Client Summary for the specified time period.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: clientSummary
      parameters:
      - name: teamId
        in: query
        description: team identifier associated with the requester's team
        required: true
        schema:
          type: string
        example: '2026-05-01'
      - name: start
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: end
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: period
        in: query
        required: true
        schema:
          type: string
          enum:
          - MONTHS
          - WEEKS
          - DAYS
      responses:
        default:
          description: default response
          content:
            application/json: {}
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
  /reports/companies:
    get:
      tags:
      - reports
      summary: Loads the Company Summary for the specified month.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: companySummary
      parameters:
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      responses:
        default:
          description: default response
          content:
            application/json: {}
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
  /reports/companies/pdf:
    get:
      tags:
      - reports
      summary: Loads the Company Summary PDF for the specified time frame.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: companySummaryPdf
      parameters:
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      - name: topN
        in: query
        schema:
          type: integer
          format: int32
          default: 3
      - name: filter
        in: query
        schema:
          type: string
      - name: groupBy
        in: query
        schema:
          type: string
          enum:
          - TEAM
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
            text/plain: {}
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/companies/reliability-management:
    get:
      tags:
      - reports
      summary: Loads the Company Reliability Management Report for the specified time window defaulting to a week.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getCompanyReliabilityManagementReport
      parameters:
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: topN
        in: query
        schema:
          type: integer
          format: int32
          default: 3
      - name: includeDailyReport
        in: query
        schema:
          type: boolean
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyReliabilityReportResponse'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/companies/reliability-management/services:
    get:
      tags:
      - reports
      summary: Loads the company service list and reliability trend for each service for the specified time window defaulting to a month.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getCompanyReliabilityManagementReport_1
      parameters:
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 4
      - name: topN
        in: query
        schema:
          type: integer
          format: int32
          default: 3
      - name: filter
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyReliabilityReportServiceListResponse'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/companies/reliability-management/grouped:
    get:
      tags:
      - reports
      summary: Loads the Company Reliability Management Report grouped by query param value of groupBy - defaults to TEAM.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getCompanyReliabilityManagementReportGrouped
      parameters:
      - name: groupBy
        in: query
        schema:
          type: string
          default: TEAM
          enum:
          - TEAM
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 4
      - name: filter
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyReliabilityReportGroupedResponse'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/companies/trends:
    get:
      tags:
      - reports
      summary: Returns the Risk and Score trends for your company across all associated services
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getCompanyScoreRiskTrends
      parameters:
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      - name: filter
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreRiskTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/detected-risk/trend:
    get:
      tags:
      - reports
      summary: Returns the trend of risks across all services for a given team
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getDetectedRisksReportTrendForTeam
      parameters:
      - name: teamId
        in: query
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/reliability-report:
    get:
      tags:
      - reports
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getReliabilityReportForTeam
      parameters:
      - name: teamId
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamReliabilityScoreReportResponse'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/reliability-report/pdf:
    get:
      tags:
      - reports
      summary: Loads the team reliability report PDF for the specified time frame.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getReliabilityReportForTeamPdf
      parameters:
      - name: teamId
        in: query
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
            text/plain: {}
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/services/reliability-management/reliability-report-trend:
    get:
      tags:
      - reports
      summary: Loads the Reliability report trend for all the services of the team for the specified time period defaulting to 1 months and 4 data points
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getReliabilityReportTrendForAllServicesOfTeam
      parameters:
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 4
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceReliabilityReportTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/services/{serviceId}/reliability-management/reliability-report-trend:
    get:
      tags:
      - reports
      summary: Loads the Reliability report trend for the service for the specified time period defaulting to 1 months and 4 data points
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getReliabilityReportTrendForService
      parameters:
      - name: serviceId
        in: path
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 4
      - name: teamId
        in: query
        description: Required when using company session token.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/reliability-report/trend:
    get:
      tags:
      - reports
      summary: Returns the trend of Reliability Scores across all services for a given team
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getReliabilityReportTrendForTeam
      parameters:
      - name: teamId
        in: query
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/detected-risks-report:
    get:
      tags:
      - reports
      summary: Loads latest risk evaluation for each eligible service for the team
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getRiskEvaluationReportForTeam
      parameters:
      - name: teamId
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamRiskReportResponse'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/detected-risks-report/pdf:
    get:
      tags:
      - reports
      summary: Loads the team risk report PDF for the specified time frame.
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getRiskEvaluationReportForTeamPdf
      parameters:
      - name: teamId
        in: query
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
            text/plain: {}
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/team/trends:
    get:
      tags:
      - reports
      summary: Returns the trend of Reliability Scores across all services for a given team
      description: Requires the privilege [`RELIABILITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: getScoreRiskTrendsForTeam
      parameters:
      - name: teamId
        in: query
        schema:
          type: string
      - name: startDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: numberOfDataPoints
        in: query
        schema:
          type: integer
          format: int32
          default: 12
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreRiskTrend'
        '403':
          description: 'User requires privilege: RELIABILITY_REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - RELIABILITY_REPORTS_READ
  /reports/pricing:
    get:
      tags:
      - reports
      summary: Loads the pricing usage for the specified dates and tracking period.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: pricingReport
      parameters:
      - name: startDate
        in: query
        description: Start date (yyyy-mm-dd) for the pricing usage. Should be within the current contract duration
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        description: End date (yyyy-mm-dd) for the pricing usage. Should be within the current contract duration
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: trackingPeriod
        in: query
        description: Tracking period for the pricing usage. Should be either Daily, Weekly or Monthly based on the contract. Defaults to the currently configured period for the company's plan
        schema:
          type: string
          enum:
          - Daily
          - Weekly
          - Monthly
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PricingReport'
            text/plain:
              schema:
                $ref: '#/components/schemas/PricingReport'
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
  /reports/teams:
    get:
      tags:
      - reports
      summary: This functionality has moved to GET /reports/teams/paged.Loads the Team Summary for the specified month.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: teamSummaries
      parameters:
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: teamId
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      deprecated: true
      security:
      - privilege:
        - REPORTS_READ
  /reports/teams/paged:
    get:
      tags:
      - reports
      summary: Loads the Team Summary for the specified month.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: teamSummariesPaged
      parameters:
      - name: startDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: endDate
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: pageSize
        in: query
        description: This value determines how many results will be returned per call.
        schema:
          type: integer
          format: int32
          default: 20
        example: 20
      - name: pageToken
        in: query
        description: Token corresponding to the last page of team summaries retrieved. Pass the pageToken to get the next page of team summaries
        schema:
          type: string
        example: None (returns first page)
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseTeamUsageReport'
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
  /reports/users:
    get:
      tags:
      - reports
      summary: Loads the User Summary for the specified time period.
      description: Requires the privilege [`REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
      operationId: userSummary
      parameters:
      - name: teamId
        in: query
        description: team identifier associated with the requester's team
        required: true
        schema:
          type: string
        example: '2026-05-01'
      - name: start
        in: query
        required: true
        schema:
          type: string
          format: date
        example: '2026-05-01'
      - name: end
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: period
        in: query
        required: true
        schema:
          type: string
          enum:
          - MONTHS
          - WEEKS
          - DAYS
      responses:
        default:
          description: default response
          content:
            application/json: {}
        '403':
          description: 'User requires privilege: REPORTS_READ'
        '401':
          description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
      security:
      - privilege:
        - REPORTS_READ
components:
  schemas:
    PricingReport:
      type: object
      properties:
        companyId:
          type: string
          description: CompanyId for which the pricing report is generated
        startDate:
          type: string
          description: Start date for the pricing report
        endDate:
          type: string
          description: End date for the pricing report
        trackingPeriod:
          type: string
          description: Tracking period of targets for the pricing report which could be Daily, Weekly or Monthly
          enum:
          - Daily
          - Weekly
          - Monthly
        usageByTrackingPeriod:
          type: array
          description: Pricing usage over the duration requested which is tracked over days, weeks or months
          items:
            $ref: '#/components/schemas/PricingUsage'
    CompanyReliabilityReportGroupedResponse:
      type: object
      properties:
        groupBy:
          type: string
          enum:
          - TEAM
        groupedServices:
          type: array
          items:
            $ref: '#/components/schemas/GroupedServiceResponse'
    TeamRiskReportResponse:
      type: object
      properties:
        teamId:
          type: string
        teamName:
          type: string
        teamRiskReports:
          type: array
          items:
            $ref: '#/components/schemas/TeamRiskReport'
    GroupedServiceResponse:
      type: object
      properties:
        groupDetails:
          $ref: '#/components/schemas/GroupDetails'
        avgScore:
          type: number
          format: double
        previousIntervalAvgScore:
          type: number
          format: double
        numOfServices:
          type: integer
          format: int32
        atRiskTotal:
          type: integer
          format: int32
        previousIntervalAtRiskTotal:
          type: integer
          format: int32
        numOfSpofs:
          type: integer
          format: int32
        reliabilityReportTrend:
          $ref: '#/components/schemas/ReportTrend'
        numOfRuns:
          type: integer
          format: int32
        previousIntervalNumOfRuns:
          type: integer
          format: int32
    ScoreRiskTrend:
      type: object
      properties:
        reliabilityScoreTrend:
          $ref: '#/components/schemas/ReportTrend'
        detectedRisksTrend:
          $ref: '#/components/schemas/ReportTrend'
        reliabilityTestsRunTrend:
          $ref: '#/components/schemas/ReportTrend'
        runSummaryStats:
          $ref: '#/components/schemas/RunSummaryStats'
    CompanyReliabilityReportResponse:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/ServicesSummary'
        start:
          type: string
          format: date
        end:
          type: string
          format: date
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServiceReportResponse'
    TeamUsageReport:
      type: object
      properties:
        companyId:
          type: string
        teamId:
          type: string
        teamName:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        gremlinMetrics:
          $ref: '#/components/schemas/GremlinMetrics'
    TeamReliabilityReportResponse:
      type: object
      properties:
        rmTestScore:
          type: number
          format: double
        score:
          type: number
          format: double
        previousInter

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/openapi/gremlin-reports-api-openapi.yml