Weekly Completion
curl --request POST \
--url https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"filters": {
"dateRange": [
"2025-06-01T00:00:00.000Z",
"2025-06-30T23:59:59.999Z"
],
"locations": [],
"project": []
},
"view": "schedules",
"page": 0
}
'import requests
url = "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion"
payload = {
"filters": {
"dateRange": ["2025-06-01T00:00:00.000Z", "2025-06-30T23:59:59.999Z"],
"locations": [],
"project": []
},
"view": "schedules",
"page": 0
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filters: {
dateRange: ['2025-06-01T00:00:00.000Z', '2025-06-30T23:59:59.999Z'],
locations: [],
project: []
},
view: 'schedules',
page: 0
})
};
fetch('https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'dateRange' => [
'2025-06-01T00:00:00.000Z',
'2025-06-30T23:59:59.999Z'
],
'locations' => [
],
'project' => [
]
],
'view' => 'schedules',
'page' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion"
payload := strings.NewReader("{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"id": "sched-2f9a1c22-1d4e-4b6a-9c11",
"title": "Restroom Inspection",
"schedule": true,
"recurringByEvery": "daily",
"startTime": "08:00",
"dueTime": "10:00",
"weeklyCompletion": [
{
"date": "6/7",
"startDate": "2025-06-01",
"endDate": "2025-06-07",
"percentage": 100
},
{
"date": "6/14",
"startDate": "2025-06-08",
"endDate": "2025-06-14",
"percentage": 86
},
{
"date": "6/21",
"startDate": "2025-06-15",
"endDate": "2025-06-21",
"percentage": 71
},
{
"date": "6/28",
"startDate": "2025-06-22",
"endDate": "2025-06-28",
"percentage": 90
}
]
}
],
"weeks": [
"6/7",
"6/14",
"6/21",
"6/28"
],
"endDate": "2025-06-30",
"page": 0
},
"meta": {}
}Reporting
Weekly Completion
Returns completion percentages per recurring schedule (or per project) for each of four weeks. The window ends at filters.dateRange[1] (or today) and can be paged forward/backward with page. The underlying route requires the CAN_VIEW_REPORTING permission — the API key acts as its default user.
POST
/
api
/
v1
/
ops
/
reports
/
tasks
/
weekly-completion
Weekly Completion
curl --request POST \
--url https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"filters": {
"dateRange": [
"2025-06-01T00:00:00.000Z",
"2025-06-30T23:59:59.999Z"
],
"locations": [],
"project": []
},
"view": "schedules",
"page": 0
}
'import requests
url = "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion"
payload = {
"filters": {
"dateRange": ["2025-06-01T00:00:00.000Z", "2025-06-30T23:59:59.999Z"],
"locations": [],
"project": []
},
"view": "schedules",
"page": 0
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filters: {
dateRange: ['2025-06-01T00:00:00.000Z', '2025-06-30T23:59:59.999Z'],
locations: [],
project: []
},
view: 'schedules',
page: 0
})
};
fetch('https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'dateRange' => [
'2025-06-01T00:00:00.000Z',
'2025-06-30T23:59:59.999Z'
],
'locations' => [
],
'project' => [
]
],
'view' => 'schedules',
'page' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion"
payload := strings.NewReader("{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/ops/reports/tasks/weekly-completion")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"dateRange\": [\n \"2025-06-01T00:00:00.000Z\",\n \"2025-06-30T23:59:59.999Z\"\n ],\n \"locations\": [],\n \"project\": []\n },\n \"view\": \"schedules\",\n \"page\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"id": "sched-2f9a1c22-1d4e-4b6a-9c11",
"title": "Restroom Inspection",
"schedule": true,
"recurringByEvery": "daily",
"startTime": "08:00",
"dueTime": "10:00",
"weeklyCompletion": [
{
"date": "6/7",
"startDate": "2025-06-01",
"endDate": "2025-06-07",
"percentage": 100
},
{
"date": "6/14",
"startDate": "2025-06-08",
"endDate": "2025-06-14",
"percentage": 86
},
{
"date": "6/21",
"startDate": "2025-06-15",
"endDate": "2025-06-21",
"percentage": 71
},
{
"date": "6/28",
"startDate": "2025-06-22",
"endDate": "2025-06-28",
"percentage": 90
}
]
}
],
"weeks": [
"6/7",
"6/14",
"6/21",
"6/28"
],
"endDate": "2025-06-30",
"page": 0
},
"meta": {}
}Returns per-schedule (or per-project) completion percentages across a rolling four-week window. Filters are wrapped under
filters, whose dateRange[1] anchors the window; page shifts the window forward (positive) or backward (negative). Requires the CAN_VIEW_REPORTING permission (inherited from the key’s default user).Body
application/json
Global report filters. dateRange[1] anchors the 4-week window.
Show child attributes
Show child attributes
Group rows by recurring schedule or by project.
Available options:
schedules, projects 0 = current 4 weeks; positive = future weeks; negative = past weeks.
Response
Weekly completion data retrieved successfully.
⌘I