> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appeeky.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reports

> List, retrieve, and delete saved ASO reports from your appeeky.com account

Access the ASO analysis reports saved in your [appeeky.com](https://appeeky.com) account. Reports are generated by tools such as [ASO Audit](/docs/aso-audit), [Competitor Report](/docs/aso-competitor-report), and [Metadata Suggestions](/docs/aso-metadata-suggest) and stored so you can retrieve them later.

<Info>
  All Report endpoints cost **0 credits** and require the `apps:read` scope for reads and `apps:write` for deletes.
</Info>

***

## List Reports

```
GET /v1/user/reports
```

Returns all saved reports for your account, ordered most recently created first.

**Query Parameters:**

| Name     | Type   | Default | Description                                                                    |
| -------- | ------ | ------- | ------------------------------------------------------------------------------ |
| `appId`  | number | —       | Filter by a specific App Store ID                                              |
| `type`   | string | —       | Filter by report type (e.g. `aso_audit`, `competitor`, `metadata_suggestions`) |
| `limit`  | number | `20`    | Max number of results to return (max `100`)                                    |
| `offset` | number | `0`     | Pagination offset                                                              |

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl "https://api.appeeky.com/v1/user/reports?appId=6443843426&limit=10" \
    -H "X-API-Key: YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const res = await fetch(
    "https://api.appeeky.com/v1/user/reports?appId=6443843426&limit=10",
    { headers: { "X-API-Key": "YOUR_API_KEY" } }
  );
  const { data } = await res.json();
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests

  res = requests.get(
      "https://api.appeeky.com/v1/user/reports",
      params={"appId": 6443843426, "limit": 10},
      headers={"X-API-Key": "YOUR_API_KEY"},
  )
  data = res.json()["data"]
  ```
</CodeGroup>

**Response (200 OK):**

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "data": [
    {
      "id": "d9f3a122-...",
      "app_id": 6443843426,
      "report_type": "aso_audit",
      "title": "ASO Audit — Appeeky",
      "summary": "Overall score: 82/100. Title length optimal. Keyword density low.",
      "created_at": "2026-03-19T15:47:06.270736+00:00"
    }
  ]
}
```

***

## Get a Report

```
GET /v1/user/reports/:reportId
```

Retrieve the full content of a single saved report.

**Path Parameters:**

| Name       | Type   | Description        |
| ---------- | ------ | ------------------ |
| `reportId` | string | UUID of the report |

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl "https://api.appeeky.com/v1/user/reports/d9f3a122-..." \
    -H "X-API-Key: YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const res = await fetch(
    "https://api.appeeky.com/v1/user/reports/d9f3a122-...",
    { headers: { "X-API-Key": "YOUR_API_KEY" } }
  );
  const { data } = await res.json();
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests

  res = requests.get(
      "https://api.appeeky.com/v1/user/reports/d9f3a122-...",
      headers={"X-API-Key": "YOUR_API_KEY"},
  )
  data = res.json()["data"]
  ```
</CodeGroup>

**Response (200 OK):**

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "data": {
    "id": "d9f3a122-...",
    "app_id": 6443843426,
    "report_type": "aso_audit",
    "title": "ASO Audit — Appeeky",
    "summary": "Overall score: 82/100. Title length optimal. Keyword density low.",
    "content": {
      "score": 82,
      "sections": [
        { "name": "Title", "score": 95, "feedback": "Title is within the 30-character limit." },
        { "name": "Keywords", "score": 68, "feedback": "Keyword field is underutilized." }
      ]
    },
    "created_at": "2026-03-19T15:47:06.270736+00:00"
  }
}
```

***

## Delete a Report

```
DELETE /v1/user/reports/:reportId
```

Permanently delete a saved report from your account.

**Path Parameters:**

| Name       | Type   | Description                  |
| ---------- | ------ | ---------------------------- |
| `reportId` | string | UUID of the report to delete |

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X DELETE "https://api.appeeky.com/v1/user/reports/d9f3a122-..." \
    -H "X-API-Key: YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const res = await fetch(
    "https://api.appeeky.com/v1/user/reports/d9f3a122-...",
    { method: "DELETE", headers: { "X-API-Key": "YOUR_API_KEY" } }
  );
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests

  requests.delete(
      "https://api.appeeky.com/v1/user/reports/d9f3a122-...",
      headers={"X-API-Key": "YOUR_API_KEY"},
  )
  ```
</CodeGroup>

**Response (200 OK):**

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{ "data": { "success": true } }
```

***

## Errors

| Status | Code             | When                                               |
| ------ | ---------------- | -------------------------------------------------- |
| 403    | `FORBIDDEN`      | Key scope does not allow this operation            |
| 404    | `USER_NOT_FOUND` | No appeeky.com account linked to this key          |
| 404    | `NOT_FOUND`      | Report not found or doesn't belong to your account |