Zally

Zally Review Statistics API

The Review Statistics API from Zally — 1 operation(s) for review statistics.

GitHub OpenAPI

Operations 1

GET /review-statistics Zally Provides Query Capabilites for Linting Summaries and Automatically… #

Documentation

📖
Documentation
https://opensource.zalando.com/zally/
📖
APIReference
https://github.com/zalando/zally/blob/main/server/zally-server/src/main/resources/api/zally-api.yaml
📖
Authentication
https://github.com/zalando/zally/tree/main/server#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/openapi/zally-review-statistics-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-schema/
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-structure/

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-ld/zally-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/examples/

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/zally-review-statistics-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.

GitHub Google LinkedIn

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

OpenAPI Specification

zally-review-statistics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zally - Zalando's API Linter Review Statistics API
  description: Zally is a quality assurance tool.
  version: 2.3.0
  x-api-id: 48aa0090-25ef-11e8-b467-0ed5f89f718b
  x-audience: company-internal
  contact:
    name: Team API Management
    email: team-api-management@zalando.de
    url: http://tech.zalando.de
servers:
- url: https://zally.on.inter.net
  description: Production Zally Web UI instance
tags:
- name: Review Statistics
paths:
  /review-statistics:
    get:
      summary: Zally Provides Query Capabilites for Linting Summaries and Automatically…
      description: 'Returns a list of all linting results and review statistics for a given

        interval in time. If none of the query parameters is supplied, a list of

        all linting results and review statistics for the last week is returned.'
      parameters:
      - $ref: '#/components/parameters/From'
      - $ref: '#/components/parameters/To'
      - $ref: '#/components/parameters/UserAgent'
      responses:
        200:
          description: List of queried review statistics
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ReviewStatisticsResponse'
              examples:
                Get_review_statistics200Example:
                  summary: Default get_review_statistics 200 response
                  x-microcks-default: true
                  value:
                    total_reviews: 23
                    total_reviews_deduplicated: 12
                    successful_reviews: 17
                    number_of_endpoints: 10
                    must_violations: 123
                    should_violations: 81
                    may_violations: 32
                    hint_violations: 5
        400:
          description: One of the query parameters is incorrect
          content:
            application/problem+json:
              schema:
                $ref: https://opensource.zalando.com/problem/schema.yaml#/Problem
              examples:
                Get_review_statistics400Example:
                  summary: Default get_review_statistics 400 response
                  x-microcks-default: true
                  value: example-value
        default:
          description: Error object
          content:
            application/problem+json:
              schema:
                $ref: https://opensource.zalando.com/problem/schema.yaml#/Problem
              examples:
                Get_review_statisticsdefaultExample:
                  summary: Default get_review_statistics default response
                  x-microcks-default: true
                  value: example-value
      security:
      - BearerAuth:
        - uid
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Review Statistics
      operationId: getReviewStatistics
      x-operation-id-source: derived
components:
  parameters:
    UserAgent:
      name: user_agent
      in: query
      description: Review statistics requested with the specified User-Agent
      required: false
      schema:
        type: string
    To:
      name: to
      in: query
      description: All review statistics until this day, only works in conjunction with from parameter
      required: false
      schema:
        type: string
        format: date
    From:
      name: from
      in: query
      description: All review statistics from this day
      required: false
      schema:
        type: string
        format: date
  schemas:
    ReviewStatisticsResponse:
      type: object
      description: Linting results and review statistics for a given interval in time
      required:
      - total_reviews
      - total_reviews_deduplicated
      - successful_reviews
      - number_of_endpoints
      - must_violations
      - should_violations
      - may_violations
      - hint_violations
      properties:
        total_reviews:
          type: integer
          format: int32
          example: 23
          description: Total number of lintings
        total_reviews_deduplicated:
          type: integer
          format: int32
          example: 12
          description: Unique APIs linted
        successful_reviews:
          type: integer
          format: int32
          example: 17
          description: Number of successful lintings
        number_of_endpoints:
          type: integer
          format: int32
          example: 10
          description: Number of endpoints in the linted APIs
        must_violations:
          type: integer
          format: int32
          example: 123
          description: Number of MUST violations
        should_violations:
          type: integer
          format: int32
          example: 81
          description: Number of SHOULD violations
        may_violations:
          type: integer
          format: int32
          example: 32
          description: Number of MAY violations
        hint_violations:
          type: integer
          format: int32
          example: 5
          description: Number of HINTS
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Open Source project's page
  url: https://opensource.zalando.com/zally/