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

# Atskaites

> Eksportējiet vienreizēju skenējumu atskaiti vai ieplānojiet regulārus atskaišu e-pastus.

> [!NOTE]
>
> GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.

Atskaites apkopo skenējumus pa QR kodiem par pabeigtu dienu, nedēļu vai mēnesi. Eksportējiet atskaiti uzreiz vai ieplānojiet atskaiti, kas regulāri tiek nosūtīta pa e-pastu.

| Metode | Ceļš | Apraksts |
| - | - | - |
| `POST` | `/api/v1/reports` | [Atskaites eksports](#atskaites-eksports) |
| `GET` | `/api/v1/reports/schedules` | [Ieplānoto atskaišu saraksts](#ieplānoto-atskaišu-saraksts) |
| `POST` | `/api/v1/reports/schedules` | [Atskaites ieplānošana](#atskaites-ieplānošana) |
| `PATCH` | `/api/v1/reports/schedules/{id}` | [Ieplānotas atskaites atjaunināšana](#ieplānotas-atskaites-atjaunināšana) |
| `DELETE` | `/api/v1/reports/schedules/{id}` | [Ieplānotas atskaites dzēšana](#ieplānotas-atskaites-dzēšana) |

## Galvenes

**Authorization** `string` *required*

`Bearer`, kam seko jūsu API atslēga. Skatiet [Autentifikācija](https://docs.getqr.com/lv/api/authentication.md).

**Content-Type** `string`

`application/json`. Obligāts pieprasījumos `POST` un `PATCH`.

## Tvērums

Gan vienreizējās, gan ieplānotās atskaites pieņem `scope`:

| `scope` | Aptver | `qrIds` |
| - | - | - |
| `all` | Jūsu darbvietas QR kodus | Izlaidiet |
| `selected` | Izvēlētu QR kodu kopu | Viens vai vairāki ID |
| `single` | Tieši vienu QR kodu | Tieši viens ID |

Atskaitē ir ne vairāk kā 50 QR kodu. Ar `all` tie ir pēdējie izveidotie aktīvie QR kodi; pauzētie kodi netiek iekļauti. Ar `selected` un `single` pauzētie kodi tiek iekļauti. QR kodiem bez īsās saites nav skenējumu, un tie tiek izlaisti.

## Periods

Periods vienmēr ir pēdējais pabeigtais, tāpēc atskaitē nekad nav šodienas nepilno datu. Tā robežas ir pusnakts atskaites laika joslā.

| `period` vai `frequency` | Aptver |
| - | - |
| `daily` | Iepriekšējo dienu |
| `weekly` | Iepriekšējo nedēļu, no pirmdienas līdz svētdienai |
| `monthly` | Iepriekšējo kalendāro mēnesi |

## Atskaites eksports

`POST /api/v1/reports`

Izveido atskaiti par pēdējo pabeigto periodu un atgriež to atbildē.

**scope** `string` *required*

`all`, `selected` vai `single`. Skatiet [Tvērums](#tvērums).

**period** `string` *required*

`daily`, `weekly` vai `monthly`. Skatiet [Periods](#periods).

**format** `string` *required*

`json` atgriež atskaiti atbildes pamattekstā. `csv` un `pdf` atgriež faila lejupielādi.

**qrIds** `string[]`

Iekļaujamie QR kodi. Obligāts ar `selected` (viens vai vairāki ID) un `single` (tieši viens ID). Ar `all` izlaidiet.

**timezone** `string` (default: UTC)

IANA laika josla, pēc kuras tiek noteiktas perioda robežas, piemēram, `America/New_York`. Nezināma laika josla atgriež `422`.

**locale** `string` (default: en)

PDF valoda, piemēram, `en` vai `de`. Neatbalstīta vērtība tiek aizstāta ar angļu valodu. `csv` un `json` to ignorē.

**name** `string`

PDF redzamais nosaukums, līdz 40 rakstzīmēm. `csv` un `json` to ignorē.

### JSON atbilde

**periodStart** `string`

Perioda pirmā diena, `YYYY-MM-DD`.

**periodEnd** `string`

Pirmā diena pēc perioda, `YYYY-MM-DD`. Periods beidzas šīs dienas sākuma pusnaktī.

**qrs** `object[]`

Viens ieraksts katram QR kodam.

**properties**

**qrId** `string`

QR koda ID.

**name** `string`

QR koda nosaukums vai `Untitled QR`.

**type** `string`

QR koda veids, piemēram, `website`.

**totalScans** `integer`

Kopējie skenējumi periodā.

**uniqueScans** `integer`

Unikālie skenējumi periodā.

**topGeography** `string`

Valsts kods ar visvairāk skenējumiem vai `—`, ja skenējumu nav.

**topDevice** `string`

Ierīce ar visvairāk skenējumiem vai `—`.

**topOs** `string`

Operētājsistēma ar visvairāk skenējumiem vai `—`.

**topBrowser** `string`

Pārlūkprogramma ar visvairāk skenējumiem vai `—`.

### CSV un PDF atbildes

Pamatteksts ir pats fails. `Content-Disposition` to nosauc pēc perioda, piemēram, `report-2026-08-10_2026-08-17.csv`. CSV failā ir viena rinda katram QR kodam ar kolonnām `QR ID`, `QR name`, `QR type`, `Total scans`, `Unique scans`, `Top geography`, `Top device`, `Top OS` un `Top browser`.

```bash JSON theme={null}
curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "period": "weekly",
    "format": "json",
    "timezone": "America/New_York"
  }'
```

```bash PDF theme={null}
curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scope": "all", "period": "monthly", "format": "pdf", "locale": "de" }' \
  --output report.pdf
```

```json 200 theme={null}
{
  "periodStart": "2026-08-10",
  "periodEnd": "2026-08-17",
  "qrs": [
    {
      "qrId": "clw3n7t1x0002ab0d5mqe8pkr",
      "name": "Landing page",
      "type": "website",
      "totalScans": 128,
      "uniqueScans": 96,
      "topGeography": "US",
      "topDevice": "Mobile",
      "topOs": "iOS",
      "topBrowser": "Safari"
    }
  ]
}
```

## Ieplānotās atskaites objekts

Ieplānotā atskaite tiek nosūtīta pa e-pastu kontam, kas to izveidoja, pusnaktī tās laika joslā.

**id** `string`

Ieplānotās atskaites ID.

**name** `string | null`

Nosaukums, kas redzams e-pasta tēmā un informācijas panelī.

**frequency** `string`

`daily`, `weekly` vai `monthly`.

**scope** `string`

`all`, `selected` vai `single`.

**qrIds** `string[] | null`

QR kodi, ko atskaite aptver ar tvērumu `selected` un `single`. `null`, ja ID netika nosūtīti.

**filters** `null`

Vienmēr `null`. Rezervēts.

**includePdf** `boolean`

Vai e-pastam ir pievienots PDF.

**status** `string`

`active` vai `paused`.

**timezone** `string`

IANA laika josla, pēc kuras tiek noteikts nosūtīšanas laiks un periods.

**locale** `string`

E-pasta un PDF valoda.

**nextRunAt** `string`

Kad jānosūta nākamais e-pasts, ISO 8601: nākamajā pusnaktī (`daily`), nākamajā pirmdienā (`weekly`) vai nākamā mēneša 1. datumā (`monthly`) atskaites laika joslā.

**lastRunAt** `string | null`

Kad tika nosūtīts pēdējais e-pasts, ISO 8601.

**createdAt** `string`

Izveides datums, ISO 8601.

**updatedAt** `string`

Pēdējās atjaunināšanas datums, ISO 8601.

## Ieplānoto atskaišu saraksts

`GET /api/v1/reports/schedules`

Atgriež jūsu darbvietas ieplānotās atskaites, arī tās, ko izveidojuši citi dalībnieki, sākot ar jaunākajām. Saraksts ir sadalīts lapās: skatiet [Lapošana](https://docs.getqr.com/lv/api/introduction.md#lapošana).

**page** `integer` (default: 1)

Atgriežamā lapa, 1 vai vairāk.

**pageSize** `integer` (default: 100)

Rezultāti lapā, no 1 līdz 100.

```bash cURL theme={null}
curl "https://getqr.com/api/v1/reports/schedules?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"
```

```json 200 theme={null}
{
  "data": [
    {
      "id": "clx8f2k9a0001qk0c8vhd3xyz",
      "name": "Weekly campaign digest",
      "frequency": "weekly",
      "scope": "selected",
      "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr", "clw3n7t1x0004ab0d9rzu2wfh"],
      "filters": null,
      "includePdf": true,
      "status": "active",
      "timezone": "America/New_York",
      "locale": "en",
      "nextRunAt": "2026-08-10T04:00:00.000Z",
      "lastRunAt": "2026-08-03T04:00:12.000Z",
      "createdAt": "2026-07-01T12:34:56.000Z",
      "updatedAt": "2026-07-28T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}
```

## Atskaites ieplānošana

`POST /api/v1/reports/schedules`

Izveido atskaiti, kas regulāri tiek nosūtīta pa e-pastu. `nextRunAt` tiek aprēķināts pēc biežuma un laika joslas.

> [!NOTE]
>
> QR kods var piederēt tikai vienai ieplānotajai atskaitei katram biežumam. Pārklājošs grafiks atgriež `409 conflict`.

Atskaite ar tvērumu `all` pārklājas ar visām citām tā paša biežuma atskaitēm. Pauzētās atskaites arī tiek ņemtas vērā.

**frequency** `string` *required*

Cik bieži atskaite tiek sūtīta: `daily`, `weekly` vai `monthly`. Nosaka arī periodu, ko tā aptver. Skatiet [Periods](#periods).

**scope** `string` *required*

`all`, `selected` vai `single`. Skatiet [Tvērums](#tvērums).

**timezone** `string` *required*

IANA laika josla, pēc kuras tiek noteikts nosūtīšanas laiks un periods, piemēram, `America/New_York`. Nezināma laika josla atgriež `422`.

**locale** `string` *required*

E-pasta un PDF valoda, piemēram, `en` vai `de`. Neatbalstīta vērtība tiek aizstāta ar angļu valodu. PDF faili valodās `zh`, `ja`, `ko` un `ar` tiek veidoti angļu valodā.

**qrIds** `string[]`

Iekļaujamie QR kodi. Obligāts ar `selected` (viens vai vairāki ID) un `single` (tieši viens ID). Katram ID jābūt QR kodam jūsu darbvietā, citādi pieprasījums atgriež `404`.

**name** `string`

Nosaukums, kas redzams e-pasta tēmā un informācijas panelī, līdz 40 rakstzīmēm.

**includePdf** `boolean` (default: false)

Pievienot e-pastam atskaites PDF versiju.

```bash cURL theme={null}
curl -X POST "https://getqr.com/api/v1/reports/schedules" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly campaign digest",
    "frequency": "weekly",
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "includePdf": true,
    "timezone": "America/New_York",
    "locale": "en"
  }'
```

```json 200 theme={null}
{
  "id": "clx8f2k9a0001qk0c8vhd3xyz",
  "name": "Weekly campaign digest",
  "frequency": "weekly",
  "scope": "selected",
  "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
  "filters": null,
  "includePdf": true,
  "status": "active",
  "timezone": "America/New_York",
  "locale": "en",
  "nextRunAt": "2026-08-10T04:00:00.000Z",
  "lastRunAt": null,
  "createdAt": "2026-08-03T12:34:56.000Z",
  "updatedAt": "2026-08-03T12:34:56.000Z"
}
```

## Ieplānotas atskaites atjaunināšana

`PATCH /api/v1/reports/schedules/{id}`

Maina ieplānotu atskaiti vai to pauzē un atsāk. Sūtiet tikai tos laukus, kurus vēlaties mainīt, vismaz vienu. Biežuma vai laika joslas maiņa, kā arī pauzētas atskaites atsākšana pārrēķina `nextRunAt`. Noteikums "viena atskaite katram biežumam" joprojām ir spēkā, tāpēc pārklājoša izmaiņa atgriež `409`.

**id** `string` *required*

Ieplānotās atskaites ID. Ņemiet to no saraksta vai izveides atbildes.

**status** `string`

`paused` aptur e-pastus, nedzēšot grafiku. `active` tos atsāk.

**name** `string`

Nosaukums, līdz 40 rakstzīmēm.

**frequency** `string`

`daily`, `weekly` vai `monthly`.

**scope** `string`

`all`, `selected` vai `single`.

**qrIds** `string[]`

Iekļaujamie QR kodi. Katram ID jābūt QR kodam jūsu darbvietā.

**includePdf** `boolean`

Pievienot e-pastam PDF.

**timezone** `string`

IANA laika josla.

**locale** `string`

E-pasta un PDF valoda.

```bash cURL theme={null}
curl -X PATCH "https://getqr.com/api/v1/reports/schedules/clx8f2k9a0001qk0c8vhd3xyz" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly campaign digest",
    "frequency": "monthly",
    "status": "active"
  }'
```

```json 200 theme={null}
{
  "id": "clx8f2k9a0001qk0c8vhd3xyz",
  "name": "Monthly campaign digest",
  "frequency": "monthly",
  "scope": "selected",
  "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
  "filters": null,
  "includePdf": true,
  "status": "active",
  "timezone": "America/New_York",
  "locale": "en",
  "nextRunAt": "2026-09-01T04:00:00.000Z",
  "lastRunAt": "2026-08-03T04:00:12.000Z",
  "createdAt": "2026-07-01T12:34:56.000Z",
  "updatedAt": "2026-08-05T10:15:00.000Z"
}
```

## Ieplānotas atskaites dzēšana

`DELETE /api/v1/reports/schedules/{id}`

Dzēš grafiku un aptur visus turpmākos e-pastus.

> [!WARNING]
>
> Ieplānotas atskaites dzēšanu nevar atsaukt.

**id** `string` *required*

Ieplānotās atskaites ID.

```bash cURL theme={null}
curl -X DELETE "https://getqr.com/api/v1/reports/schedules/clx8f2k9a0001qk0c8vhd3xyz" \
  -H "Authorization: Bearer $GETQR_API_KEY"
```

```json 200 theme={null}
{ "id": "clx8f2k9a0001qk0c8vhd3xyz", "deleted": true }
```

## Biežākās problēmas

> [accordion] 404, eksportējot atskaiti
>
> Ar tvērumu `selected` vai `single` neviens no `qrIds` neatbilda QR kodam ar īso saiti jūsu darbvietā. Pārbaudiet ID.

> [accordion] 404 "QR not found.", ieplānojot atskaiti
>
> Viens no `qrIds` nav QR kods jūsu darbvietā, vai tas tika dzēsts. Pārbaudiet ID ar [QR kodu sarakstu](https://docs.getqr.com/lv/api/endpoints/qr-codes.md).

> [accordion] 409, ieplānojot atskaiti
>
> Kāds no QR kodiem jau pieder ieplānotai atskaitei ar tādu pašu biežumu, vai šī biežuma atskaite izmanto tvērumu `all`. Rediģējiet vai dzēsiet šo atskaiti vai izvēlieties citu biežumu.

> [accordion] 404 "Scheduled report not found."
>
> `id` neatbilst nevienai ieplānotai atskaitei jūsu darbvietā. Ņemiet to no [ieplānoto atskaišu saraksta](#ieplānoto-atskaišu-saraksts).

> [accordion] Atskaitē trūkst šodienas skenējumu
>
> Atskaites aptver tikai pēdējo pabeigto periodu. Aktuāliem skaitļiem izmantojiet [Analītika](https://docs.getqr.com/lv/api/endpoints/analytics.md).

## Kas tālāk

> [card] [Analītika](https://docs.getqr.com/lv/api/endpoints/analytics.md)

> [card] [Ieplānotās atskaites lietotnē](https://docs.getqr.com/lv/analytics/scheduled-reports.md)

> [card] [Atskaišu lasīšana](https://docs.getqr.com/lv/analytics/reading-reports.md)

> [card] [Kļūdas](https://docs.getqr.com/lv/api/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.