<!-- https://developers.silktide.com/v1/governance/reports/update-report | Governance / Reports -->

# Rename a report, or change what a live report covers

`PUT /v1/reports/{reportId}`

Changes a report. Send only what you want to change; the response is the whole report, as [Get a report](https://developers.silktide.com/v1/governance/reports/get-report.md) returns it.

What you may change depends on the report:

- **A live report**: `name`, `durationInterval`, `durationPeriod` and `context`.
- **A snapshot**: only `name`. It cannot be rebuilt, so its dates and what it covers stay as they were made.

Anything else you send, including a snapshot's dates or context, and `isLive` or `reportTemplateId` on any report, is ignored without an error. Check the response to see what changed. To cover something else with a snapshot, [create a new one](https://developers.silktide.com/v1/governance/reports/create-report.md).

`context` replaces the whole context, and is not checked: send it in the shape the report's `contextTypeId` takes (see [Context](https://developers.silktide.com/v1/concepts/context.md)). Ids may be numbers or strings of digits; they are stored as numbers.

## Request

### Path parameters

- `reportId` (integer, required, at least 1): The report.

### Body

- `report` (object, optional): What to change. Fields left out keep their value.
  - `name` (string, optional, at least 1 characters): Its name.
  - `durationInterval` (string, optional): Live reports only. The unit of how far back it looks. One of: `day`, `week`, `month`, `year`.
  - `durationPeriod` (integer, optional, 1 to 90): Live reports only. How many `durationInterval`s back it looks, up to `90`.
  - `context` (object or map of any JSON or empty list, optional): Live reports only. What it covers, in the shape its `contextTypeId` takes. Replaces the whole context.
    - `websiteId` (integer, required, at least 1): The website.
    - `sectionId` (integer, required): One of its sections. `0` for the whole website.

## Response

Status `200`.

- `report` (object, required): The report, changed.
  - `reportId` (integer, required, at least 1): The report.
  - `reportTemplateId` (string, required, 1 to 16 characters): The report template it is made from.
  - `reportScheduleId` (integer, required): The report schedule that made it. `0` when it was not made by a schedule.
  - `contextTypeId` (string, required): What kind of thing it covers, copied from its template: `website`, `websites`, `account` or `property`. One of: `website`, `websites`, `account`, `property`.
  - `name` (string, required, at least 1 characters): Its name.
  - `thumbnailUrl` (string, required): A small screenshot of it. Empty until one is made, a few minutes after a snapshot is created.
  - `startTime` (integer, required): For a snapshot, the start of the dates it covers. `0` for a live report.
  - `endTime` (integer, required): For a snapshot, the end of the dates it covers. `0` for a live report.
  - `durationInterval` (string, required): The unit of how far back it looks. One of: `day`, `week`, `month`, `year`.
  - `durationPeriod` (integer, required, 0 to 90): How many `durationInterval`s back it looks. `week` and `4` cover the last four weeks.
  - `created` (integer, required): When it was created.
  - `creatorAssigneeId` (string, required): The assignee who created it: a user (`u:`), an API key (`a:`), or `system` for those Silktide made itself.
  - `context` (object or map of any JSON or empty list, required): What it covers, in the shape its `contextTypeId` takes: `{"websiteId": 3, "sectionId": 0}` for one website, `{"criteria": {...}}` for several. `[]` when it has none.
    - `websiteId` (integer, required, at least 1): The website.
    - `sectionId` (integer, required): One of its sections. `0` for the whole website.
  - `isLive` (boolean, required): `true` for a live report (a dashboard), which is built afresh each time it is read. `false` for a snapshot, built once when it is created.
  - `version` (integer, required, at least 1): The version of the format it is stored in, which Silktide uses to upgrade older reports. Nothing to act on.
- `permissions` (object, required): Who may see and admin the report.
  - `components` (list of objects, required): The permissions a report has: one to see it, one to admin it.
    - `permissionId` (string, required): The permission, such as `Report-ReportRead`.
    - `componentType` (string, required): What can be given it. `assignees` for users and roles.
    - `label` (string, required): Its name, such as `Can see this dashboard / snapshot`.
    - `description` (string, required, can be null): What it allows. Null for these permissions.
    - `inheritedPermissionIds` (list of strings, required): Permissions that include this one: anyone with those has this too.
    - `models` (list of any JSON, required): Reserved. Empty for these permissions.
  - `componentValues` (map of list of strings, required): Who was given each permission on this report directly, as assignee ids (`u:` users, `g:` roles).
  - `fixedValues` (map of list of strings, required): Who has each permission from elsewhere, such as account-wide roles. Changed elsewhere, not here.

## Errors

| Status | Type | When |
| --- | --- | --- |
| 403 | `EditionNotAvailable` | The account does not have Silktide 4. Reports, report schedules and report templates are Silktide 4's, so an account with only Silktide 5 cannot use them. |
| 400 | `InvalidRequest` | `reportId` is not a whole number. `properties.field` is `reportId`. |
| 404 | `ModelNotFound` | No report with that id exists in the account. |
| 403 | `AccessDenied` | The API key's user cannot see or admin the report. |
| 400 | `InvalidRequest` | `report` or `permissions` is not an object, or a changed value does not fit: `name` is empty or contains `<`, `>` or control characters, `durationPeriod` is not a whole number from 1 to 90, or `durationInterval` is not one of its values. Values equal to the stored ones are not checked. `properties.field` names the field. |
| 401 | `NotLoggedIn` | No API key was sent, or it is not a key for this region. |
| 429 | `TooManyRequests` | Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats. |
| 503 | - | Silktide is busy. Retry after the number of seconds in the `Retry-After` header. |

## Access

- Permission: Can admin this dashboard / snapshot
- Plan feature: none
- Edition: Silktide 4 only
- Cost: free
- Stability: stable, since 1.0.0

## Example: Point a live report at one section, over the last 90 days

```bash
curl -X PUT "https://api.eu.silktide.com/v1/reports/5" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report": {
    "name": "Wine Barrel shop links",
    "durationInterval": "day",
    "durationPeriod": 90,
    "context": {
      "websiteId": 3,
      "sectionId": 1
    }
  }
}'
```

Response:

```json
{
  "report": {
    "reportId": 5,
    "reportTemplateId": "broken-links",
    "reportScheduleId": 0,
    "contextTypeId": "website",
    "name": "Wine Barrel shop links",
    "thumbnailUrl": "",
    "startTime": 0,
    "endTime": 0,
    "durationInterval": "day",
    "durationPeriod": 90,
    "created": 1794235546,
    "creatorAssigneeId": "a:3",
    "context": {
      "websiteId": 3,
      "sectionId": 1
    },
    "isLive": true,
    "version": 3
  },
  "permissions": {
    "components": [
      {
        "permissionId": "Report-ReportRead",
        "componentType": "assignees",
        "label": "Can see this dashboard / snapshot",
        "description": null,
        "inheritedPermissionIds": [
          "Report-ReportAdmin",
          "Report-ReportReadAll"
        ],
        "models": []
      },
      {
        "permissionId": "Report-ReportAdmin",
        "componentType": "assignees",
        "label": "Can admin this dashboard / snapshot",
        "description": null,
        "inheritedPermissionIds": [
          "Report-ReportAdminAll"
        ],
        "models": []
      }
    ],
    "componentValues": {
      "Report-ReportRead": [],
      "Report-ReportAdmin": []
    },
    "fixedValues": {
      "Report-ReportRead": [],
      "Report-ReportAdmin": [],
      "Report-ReportReadAll": [
        "g:2",
        "u:eu-12"
      ],
      "Report-ReportAdminAll": [
        "g:2",
        "u:eu-12"
      ]
    }
  }
}
```