---
title: "Get changelog summary"
method: GET
path: "/changelog-summary"
---

# Get changelog summary

`GET /changelog-summary`

## Request

- Base URL: `https://app.aikido.dev/api/public/v1`
- URL: `https://app.aikido.dev/api/public/v1/changelog-summary`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://app.aikido.io/api/oauth/token` scopes: `research:read`

Get changelog summary for package

## Query parameters

- `package_name` string, required
- `from_version` string, required
- `to_version` string, required
- `language` 'JS' | 'PY' | 'GO' | '.NET' | 'Java' | 'Scala' | 'Kotlin', required

## Response `200`

Information about the changelog summary is returned

- object
  - `summary` object: An object containing information about the changelog summary. Is null when summary is not yet available
    - `package_name` string: Package name related to the changelog summary
    - `from_version` string: The version of the package used as a starting point for the changelog summary
    - `to_version` string: The version of the package used as an ending point for the changelog summary
    - `source_url` string: External url that contains info about the changes
    - `failed_at` integer: Timestamp of when the changelog summary generation failed. -1 when changelog summary generation was successful
    - `failure_error_message` string: Error message related to the failure of the changelog summary generation.
    - `update_status` string: Status indicating if updating the package is safe. Can be 'safe', 'breaking' or 'unknown'
    - `changes_by_version` object: An object summarizing the potential breaking changes for the version at which they occur
      - `version` string[]: An array explaining every change for the version specified in the key
  - `is_generating` boolean: A boolean indicating if the changelog summary is still generating or not. When it is still generating try the api again at a later time

---

[API](https://skmtc.dev/aikido/apis/aikido-security-api-documentation.md) - [All operations](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/revisions/da8691338133?raw)