Depot csat

Registers the two survey routes UNGUARDED and the operator’s report GUARDED, on one mount because they are one feature and splitting them is how the guarded half ends up with the unguarded half’s reasoning applied to it.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GET /api/v1/csat-responses

GETticket:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

listCsatResponses serves the desk’s satisfaction report.

Paged in SQL rather than in Go, unlike most lists in this package: this table grows by one row per solved ticket forever and never shrinks, so the read-everything-then-slice shape the queue lists use would decrypt a comment per survey the desk has ever sent to render twenty five of them.

THE RATING FILTER IS THE POINT OF THE PAGE. A satisfaction report nobody can ask “show me the ones and twos” is a report that only ever confirms the average, and the rows worth reading are the ones that drag it down.

The SEARCH matches the ticket REFERENCE and nothing else, because the comment and the subject are both encrypted. That limit has to reach the console’s empty state: a search box that quietly cannot look inside the comments reads as a broken report rather than as a narrower one.

Parameters

Name	In	Type	Required	Description
dir	query	string, one of asc, desc	No	Sort direction.
page	query	integer	No	One-based page number. Defaults to 1.
pageSize	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
q	query	string	No	Free-text search term.
rating	query	string, one of 1, 2, 3, 4, 5	No	Comma-separated set. An unrecognised value is refused.
respondedAfter	query	string	No
respondedBefore	query	string	No
sort	query	string, one of responded, score, sent	No	Sort key.

Responses

Status	Body	Description
200	application/json, CsatResultList	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold ticket:read.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
itemsrequired	array of CsatResultView
items[].commentrequired	string
items[].respondedAtrequired	string (date-time)
items[].scorerequired	integer
items[].sentAtrequired	string (date-time)
items[].surveyPublicIdrequired	string
items[].ticketPublicIdrequired	string
items[].ticketReferencerequired	string
items[].ticketSubjectrequired	string
pagerequired	integer
pageSizerequired	integer
summaryrequired	CsatSummaryView	csatSummaryView is the roll-up beside the page.
summary.averageScorerequired	number	double.
summary.responseCountrequired	integer
summary.scoreCountsrequired	array of integer	at least 5 items. at most 5 items.
summary.sentCountrequired	integer
totalrequired	integer

Request samples

curl

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/csat-responses?dir=asc&page=0&pageSize=0&q=<q>&rating=1&respondedAfter=<respondedAfter>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

PowerShell

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/csat-responses?dir=asc&page=0&pageSize=0&q=<q>&rating=1&respondedAfter=<respondedAfter>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/csat-responses"
params = {
    "dir": "asc",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
    "rating": "1",
    "respondedAfter": "<respondedAfter>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

Go

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/csat-responses?dir=asc&page=0&pageSize=0&q=<q>&rating=1&respondedAfter=<respondedAfter>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = new URL("https://depot.example.com/api/v1/csat-responses");
url.searchParams.set("dir", "asc");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");
url.searchParams.set("rating", "1");
url.searchParams.set("respondedAfter", "<respondedAfter>");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/csat-responses?dir=asc&page=0&pageSize=0&q=<q>&rating=1&respondedAfter=<respondedAfter>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET /api/v1/csat/{token}

GETNo permission neededtenant facehosteditmspremoteIdempotentToken in the path

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Get csat survey

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	application/json, CsatSurveyView	Success.
404	application/problem+json, ProblemDetails	This survey link is no longer valid. It may have expired, or the survey may already have been answered.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
expiresAtrequired	string (date-time)
referencerequired	string
respondedrequired	boolean
score	integer
subjectrequired	string

Request samples

curl

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/csat/<token>' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/csat/<token>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/csat/<token>"
headers = {
    "Accept": "application/json",
}

response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
print(response.json())

Go

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/csat/<token>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.

const url = "https://depot.example.com/api/v1/csat/<token>";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/csat/<token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST /api/v1/csat/{token}

POSTNo permission neededtenant facehosteditmspremoteToken in the path

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Submit csat survey

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Request body

Required, sent as application/json.

Field	Type	Description
commentrequired	string
scorerequired	integer

Responses

Status	Body	Description
200	application/json, CsatSurveyView	Success.
400	application/problem+json, ProblemDetails	The request body is not valid JSON.
404	application/problem+json, ProblemDetails	This survey link is no longer valid. It may have expired, or the survey may already have been answered.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
expiresAtrequired	string (date-time)
referencerequired	string
respondedrequired	boolean
score	integer
subjectrequired	string

Request samples

curl

# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/csat/<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "comment": "string",
  "score": 0
}'

PowerShell

# This operation is public. It takes no credentials.

$headers = @{
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
}

$body = @'
{
  "comment": "string",
  "score": 0
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/csat/<token>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.

import requests

url = "https://depot.example.com/api/v1/csat/<token>"
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "comment": "string",
    "score": 0,
}

response = requests.post(url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

Go

// This operation is public. It takes no credentials.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "comment": "string",
  "score": 0
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/csat/<token>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// This operation is public. It takes no credentials.

const url = "https://depot.example.com/api/v1/csat/<token>";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "comment": "string",
    "score": 0
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// This operation is public. It takes no credentials.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "comment": "string",
  "score": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/csat/<token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET /api/v1/public/csat/{token}

GETNo permission neededshared facehosteditmspremoteIdempotentToken in the path

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Get csat survey

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Responses

Status	Body	Description
200	application/json, CsatSurveyView	Success.
404	application/problem+json, ProblemDetails	This survey link is no longer valid. It may have expired, or the survey may already have been answered.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
expiresAtrequired	string (date-time)
referencerequired	string
respondedrequired	boolean
score	integer
subjectrequired	string

Request samples

curl

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/csat/<token>' \
  -H 'Accept: application/json'

PowerShell

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'Accept' = 'application/json'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/public/csat/<token>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/public/csat/<token>"
headers = {
    "Accept": "application/json",
}

response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
print(response.json())

Go

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/public/csat/<token>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.

const url = "https://depot.example.com/api/v1/public/csat/<token>";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// This operation is public. It takes no credentials.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/public/csat/<token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST /api/v1/public/csat/{token}

POSTNo permission neededshared facehosteditmspremoteToken in the path

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Submit csat survey

Parameters

Name	In	Type	Required	Description
token	path	string	Yes

Request body

Required, sent as application/json.

Field	Type	Description
commentrequired	string
scorerequired	integer

Responses

Status	Body	Description
200	application/json, CsatSurveyView	Success.
400	application/problem+json, ProblemDetails	The request body is not valid JSON.
404	application/problem+json, ProblemDetails	This survey link is no longer valid. It may have expired, or the survey may already have been answered.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
expiresAtrequired	string (date-time)
referencerequired	string
respondedrequired	boolean
score	integer
subjectrequired	string

Request samples

curl

# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/csat/<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "comment": "string",
  "score": 0
}'

PowerShell

# This operation is public. It takes no credentials.

$headers = @{
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
}

$body = @'
{
  "comment": "string",
  "score": 0
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/public/csat/<token>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

Python

# This operation is public. It takes no credentials.

import requests

url = "https://depot.example.com/api/v1/public/csat/<token>"
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "comment": "string",
    "score": 0,
}

response = requests.post(url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

Go

// This operation is public. It takes no credentials.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "comment": "string",
  "score": 0
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/public/csat/<token>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// This operation is public. It takes no credentials.

const url = "https://depot.example.com/api/v1/public/csat/<token>";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "comment": "string",
    "score": 0
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// This operation is public. It takes no credentials.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "comment": "string",
  "score": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/public/csat/<token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());