Sample Feedback Request

With your API key in hand, you're ready to start sending feedback and feature requests from your app. Below is a basic example of how to structure your API request:

Submit user feedback

post

This endpoint allows you to submit user feedback, including bug reports, feature requests, or general comments, for a specific mobile application.

Authorizations

x-api-keystringRequired

Body

messagestringOptional

The feedback message provided by the user.

Example: This is user generated feedback.

appIdstringOptional

Unique identifier of the application.

Example: app456

appNamestringOptional

Name of the application.

Example: Auth App

platformstringOptional

The platform on which the feedback is being provided (e.g., iOS, Android).

Example: iOS

osVersionstringOptional

The operating system version of the user's device.

Example: 14.4

appVersionstringOptional

The version of the application.

Example: 1.0.0

localestringOptional

The locale of the user's device.

Example: en-US

environmentstringOptional

The environment in which the feedback is being provided (e.g., production, development).

Example: production

metadataobjectOptional

Additional metadata associated with the feedback.

Example: {"key1":"value1","key2":"value2"}

feedbackTypestringOptional

Type of feedback (e.g., bug, feature request, other).

Example: bug

tagsstring[]Optional

A list of tags associated with the feedback.

Example: ["tag1","tag2"]

Responses

200

Feedback created successfully

application/json

messagestringOptionalExample: Feedback created successfully

400

Bad request

401

Unauthorized

500

Internal server error

post/feedbacks

POST /feedbacks HTTP/1.1
Host: api.mobilefeedback.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "message": "This is user generated feedback.",
  "appId": "app456",
  "appName": "Auth App",
  "platform": "iOS",
  "osVersion": 14.4,
  "appVersion": "1.0.0",
  "locale": "en-US",
  "environment": "production",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "feedbackType": "bug",
  "tags": [
    "tag1",
    "tag2"
  ],
  "userDetails": {
    "name": "Hamdi Ceylan",
    "email": "[e-mail]",
    "userId": "user789"
  }
}

{
  "message": "Feedback created successfully"
}