POST
/
v1
/
support
/
reports
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.support.submitSupportReport({
  body: {},
})
{
  "reference": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
requestId
string<uuid>
required

Client-generated UUID for this report. Reuse it with the same draft when retrying an unconfirmed submission.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
category
enum<string>
required

Choose problem to report a fault, help to request support, or suggestion to propose an improvement.

Available options:
problem,
help,
suggestion
​
description
string
required

a string that will be trimmed

​
email
string
required

a string that will be trimmed

​
route
string
required

Page path where the report originated. Only the route family is stored; identifiers, queries and fragments are discarded.

Maximum string length: 300
​
browser
string

Optional coarse browser family and desktop or mobile type, without a full user agent or device identifiers.

Maximum string length: 80
​
release
string

Optional deployed release SHA or version. Omit when unavailable.

Maximum string length: 80
Pattern: ^[a-zA-Z0-9._-]*$
​
sentryEventId
string

Optional exact 32-character hexadecimal Sentry event ID returned when an error was captured. Omit for ordinary feedback; this does not confirm remote ingestion.

Pattern: ^[a-f0-9]{32}$
​
website
string

Spam-trap field. Leave empty or omit it; non-empty values are rejected.

Maximum string length: 200

Response

Success

​
reference
string
required