---
title: "Read the Black List analysis of a coverage report."
method: GET
path: "/artifacts/{artifactId}/coverage/blacklist"
tags: ["Artifacts"]
---

# Read the Black List analysis of a coverage report.

`GET /artifacts/{artifactId}/coverage/blacklist`

## Request

- Base URL: `https://docs.sleeperhit.studio/api/v1`
- URL: `https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/coverage/blacklist`
- Auth: HTTP bearer

The Black List analysis of one coverage report (`reportId`, else the latest complete one), as the Coverage tab shows it, through its core. It runs by itself after a coverage report completes; `blackList` is null until then, or when professional coverage add-ons are not available for this episode. A `reportId` that does not cover this screenplay is refused with 400. Read-only; costs no credits.

## Query parameters

- `reportId` string

## Response `200`

The analysis, or null.

- BlackListAnalysisResponse
  - `artifactId` string, required: The id you addressed.
  - `coverageReportId` string, nullable, required: The coverage report analysed: the one asked for, else the latest complete one; null when none.
  - `blackList` object, nullable, required: Null until it has run, or when professional coverage add-ons are not available for this episode.
    - `id` string
    - `status` string: analyzing, complete or failed.
    - `progressDetail` string, nullable
    - `failureMessage` string, nullable
    - `report` object, nullable
    - `createdAt` string, date-time

## Other responses

- `400`: Request payload failed validation. The error message names the offending field.
- `401`: Missing, malformed, revoked, or expired API key.
- `403`: API key is valid but lacks the scope, is blocked by IP allowlist, or the account is disabled.
- `404`: The named project or source does not exist or is owned by another account.
- `429`: Rate limit for this API key + IP + route family was exceeded.
- `500`: The API failed unexpectedly. Safe to retry with the same Idempotency-Key.

---

[API](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api.md) · [All operations](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/revisions/4534f5d25540?raw)