Feedback

Send a message from the user to platform support by email.

This operation sends a message from the user to platform support, which is how an in-application "ask for help" or "suggest a feature" control reaches a human. A screenshot and a browser log can travel with it, and arrive as email attachments.

Feedback object

{
  "text": "My feedback",
  "useragent": "Chrome/87.0.4280.88",
  "platform": "Windows NT 10.0; Win64; x64",
  "screenshots": ["encoded image1", "encoded image2"],
  "log": <log_file>
}

• text - string. The feedback text. Cannot be null.

• useragent - optional string. The user's browser.

• platform - optional string. The user's operating system.

• screenshots - optional string array. Base64-encoded data URL images, for example data:image/jpeg;base64,[encoded image].

• log - optional log file holding the browser log.

API actions

API base path: /feedback.

Operations that list no errors of their own return only the general error codes.

---

Send feedback

post

/feedback/send_email

Send a message from the user to platform support by email.

A screenshot and a log can be attached, and are delivered as email attachments.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body

typestring · enumOptional

Optional. Default support_request. What kind of message this is.

Possible values:

Responses

200

Feedback sent

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/feedback/send_email

POST /v2/feedback/send_email HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "feedback": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "support_request"
}

{
  "success": true
}