---
title: "Impacted files comparison"
method: GET
path: "/{service}/{owner_username}/repos/{repo_name}/compare/impacted_files"
tags: ["Comparison"]
---

# Impacted files comparison

`GET /{service}/{owner_username}/repos/{repo_name}/compare/impacted_files`

## Request

- Base URL: `https://api.codecov.io/api/v2`
- URL: `https://api.codecov.io/api/v2/{service}/{owner_username}/repos/{repo_name}/compare/impacted_files`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/codecov/apis/codecov-api/docs/:service/:owner_username/repos/:repo_name/compare/impacted_files/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a comparison for either a pair of commits or a pull
Will only return pre-computed impacted files comparisons if available
If unavailable `files` will be empty, however once the computation is ready
the files will appear on subsequent calls
`state: "processed"` means `files` are finished computing and returned
`state: "pending"` means `files` are still computing, poll again later

## Path parameters

- `owner_username` string, required
- `repo_name` string, required
- `service` 'bitbucket' | 'bitbucket_server' | 'github' | 'github_enterprise' | 'gitlab' | 'gitlab_enterprise', required

## Query parameters

- `base` string
- `head` string
- `pullid` integer

## Response `200`

- ImpactedFilesComparison
  - `base_commit` string, required
  - `head_commit` string, required
  - `totals` TotalsComparison, required
    - `base` ReportTotals, required
      - `files` integer, required
      - `lines` integer, required
      - `hits` integer, required
      - `misses` integer, required
      - `partials` integer, required
      - `coverage` number, double, required
      - `branches` integer, required
      - `methods` integer, required
      - `messages` integer, required
      - `sessions` integer, required
      - `complexity` number, double, required
      - `complexity_total` number, double, required
      - `complexity_ratio` number, double, required
      - `diff` unknown, required
    - `head` ReportTotals, required
      - `files` integer, required
      - `lines` integer, required
      - `hits` integer, required
      - `misses` integer, required
      - `partials` integer, required
      - `coverage` number, double, required
      - `branches` integer, required
      - `methods` integer, required
      - `messages` integer, required
      - `sessions` integer, required
      - `complexity` number, double, required
      - `complexity_total` number, double, required
      - `complexity_ratio` number, double, required
      - `diff` unknown, required
    - `patch` ReportTotals, required
      - `files` integer, required
      - `lines` integer, required
      - `hits` integer, required
      - `misses` integer, required
      - `partials` integer, required
      - `coverage` number, double, required
      - `branches` integer, required
      - `methods` integer, required
      - `messages` integer, required
      - `sessions` integer, required
      - `complexity` number, double, required
      - `complexity_total` number, double, required
      - `complexity_ratio` number, double, required
      - `diff` unknown, required
  - `commit_uploads` Commit[], required
    - `commitid` string, required
    - `message` string, required
    - `timestamp` string, date-time, required
    - `ci_passed` boolean, required
    - `author` Owner, required
      - `service` 'github' | 'gitlab' | 'bitbucket' | 'github_enterprise' | 'gitlab_enterprise' | 'bitbucket_server', required: * `github` - Github * `gitlab` - Gitlab * `bitbucket` - Bitbucket * `github_enterprise` - Github Enterprise * `gitlab_enterprise` - Gitlab Enterprise * `bitbucket_server` - Bitbucket Server
      - `username` string, nullable, required
      - `name` string, nullable, required
    - `branch` string, required
    - `totals` CommitTotals, required
      - `files` integer, required
      - `lines` integer, required
      - `hits` integer, required
      - `misses` integer, required
      - `partials` integer, required
      - `coverage` number, double, required
      - `branches` integer, required
      - `methods` integer, required
      - `sessions` integer, required
      - `complexity` number, double, required
      - `complexity_total` number, double, required
      - `complexity_ratio` number, double, required
      - `diff` integer, required
    - `state` 'complete' | 'pending' | 'error' | 'skipped', required: * `complete` - Complete * `pending` - Pending * `error` - Error * `skipped` - Skipped
    - `parent` string, required
  - `diff` object, required
  - `files` object[], required
  - `untracked` string[], required
  - `state` string, required

---

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