Reports

Analytics reports. Every example sets SOOQUNA_TOKEN from the environment; see authentication. Responses are from a test store, cut to two items per list.

Endpoint	Method	Path
List available reports	GET	`/analytics/reports`
Run a report	GET	`/analytics/reports/{key}`

List available reports

GET /analytics/reports · Scope: read_reports

curl -X GET "https://api.sooquna.com/admin/api/2026-10/analytics/reports" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/analytics/reports", {
  method: "GET",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
  },
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.get(
    "https://api.sooquna.com/admin/api/2026-10/analytics/reports",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/analytics/reports');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/analytics/reports", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/analytics/reports");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Response 200

{
  "data": [
    {
      "category": "sales",
      "chart": "line",
      "columns": [
        {"key": "period", "type": "date"},
        {"key": "orders", "type": "int"}
      ],
      "group_by": ["day", "week"],
      "key": "sales_over_time"
    },
    {
      "category": "sales",
      "chart": "bar",
      "columns": [
        {"key": "product", "type": "text"},
        {"key": "orders", "type": "int"}
      ],
      "key": "sales_by_product"
    }
  ]
}

Run a report

GET /analytics/reports/{key} · Scope: read_reports

Parameter	In	Description
`key`	path	The key ID.
`group_by`	query	For example `day`.

curl -X GET "https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day" \
  -H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

const res = await fetch("https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day", {
  method: "GET",
  headers: {
    "X-Sooquna-Access-Token": process.env.SOOQUNA_TOKEN,
  },
});
if (!res.ok) throw new Error(`${res.status}: ${await res.text()}`);
const data = await res.json();
console.log(data);

import os
import requests

res = requests.get(
    "https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day",
    headers={
        "X-Sooquna-Access-Token": os.environ["SOOQUNA_TOKEN"],
    },
)
res.raise_for_status()
print(res.json())

<?php
$ch = curl_init('https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'X-Sooquna-Access-Token: ' . getenv('SOOQUNA_TOKEN'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
$data = json_decode($response, true);
print_r($data);

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-Sooquna-Access-Token", os.Getenv("SOOQUNA_TOKEN"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  if res.StatusCode >= 300 {
    data, _ := io.ReadAll(res.Body)
    panic(fmt.Sprintf("%d: %s", res.StatusCode, data))
  }
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

using System.Text;

using var client = new HttpClient();
var req = new HttpRequestMessage(HttpMethod.Get, "https://api.sooquna.com/admin/api/2026-10/analytics/reports/sales_over_time?group_by=day");
req.Headers.Add("X-Sooquna-Access-Token", Environment.GetEnvironmentVariable("SOOQUNA_TOKEN"));
var res = await client.SendAsync(req);
if (!res.IsSuccessStatusCode) throw new Exception($"{(int)res.StatusCode}: {await res.Content.ReadAsStringAsync()}");
Console.WriteLine(await res.Content.ReadAsStringAsync());

Response 200

{
  "currency": "QAR",
  "group_by": "day",
  "range": {"from": "2026-10-18T09:30:00Z", "to": "2026-10-18T09:30:00Z"},
  "report": {
    "category": "sales",
    "chart": "line",
    "columns": [
      {"key": "period", "type": "date"},
      {"key": "orders", "type": "int"}
    ],
    "group_by": ["day", "week"],
    "key": "sales_over_time"
  },
  "rows": [["2026-09-19", 0], ["2026-09-20", 0]],
  "totals": [null, 0]
}

Was this page helpful?