submit_feedback¶

ManagementApi.submit_feedback(submit_feedback_request, content_type=None, role_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Submit user feedback

Stores the caller’s feedback. Message is required. IssueName, Path, and StackTrace default to n/a when omitted.

Parameters:

submit_feedback_request (SubmitFeedbackRequest) – (required)
content_type (str)
role_id (str) – Amorphic role ID recorded in audit logs. Not used for authorization on this path.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SubmitFeedbackResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: POST /feedback

Request¶

Request / response example

{
  "Message": "Export failed on the datasets page",
  "IssueName": "Export timeout",
  "Path": "/datasets",
  "StackTrace": "TimeoutError: ..."
}

Success (HTTP 200)¶

Feedback stored. Message is always “Feedback/Issue submitted successfully!”.

Request / response example

{
  "Message": "Feedback/Issue submitted successfully!"
}

Errors¶

Documented error codes: IPV-1001, GE-1008.

HTTP 400

Empty value on a present body field. Body is {“Message”: “<CODE> - <text>”}. Code: IPV-1001.

Message present but empty

{
  "Message": "IPV-1001 - Parameter Message is a required value."
}

HTTP 500

Invalid JSON, missing Message after the request reached the handler, or store failure. Body is {“Message”: “GE-1008 - Could not complete the request. Please try again.”}.

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}