Rating Score

The ratingScore API is used to submit a Rating Score to the Feedback API. This API is used to collect feedback from users in the form of a rating score response.

API BASE URL: https://addhuri.com/api/lib/feedback

POST API

This POST request can be used to submit a Rating Score to the Feedback API.

Request Endpoint

POST /ratingScore

Request Headers

Use the poster API key in the request headers to authenticate the request.

{
  "Content-Type": "application/json",
  "x-api-key-poster": "YOUR_POSTER_API_KEY",
}

Request Body

{
  "question": "string",
  "options": [
    {
      "text": "string",
      "value": "anytype",
      "data": {}
    },
    {
      "text": "string",
      "value": "anytype",
      "data": {}
    }
  ],
  "selectedOptions": [
    {
      "text": "string",
      "value": "anytype",
      "data": {}
    }
  ],
  "data": {}
}

Response Body

{
  "data": {
    "id": "string"
  },
  "message": "Feedback saved successfully",
  "status": "success"
}

Example

Here is an example of how to submit a Rating Score to the Feedback API using different programming languages and tools.

JavaScript

const API_BASE_URL = 'https://addhuri.com/api/lib/feedback'
const URL = `${API_BASE_URL}/ratingScore`
const POSTER_API_KEY = 'YOUR_POSTER_API_KEY'

fetch(URL, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key-poster': POSTER_API_KEY
  },
  body: JSON.stringify({
    "question": "Rate the quality of the API",
    "options": [
      {
        "text": "Excellent",
        "value": 10,
        "data": {}
      },
      {
        "text": "Good",
        "value": 5,
        "data": {}
      },
      {
        "text": "Average",
        "value": 0,
        "data": {}
      }
    ],
    "selectedOptions": [
      {
        "text": "Excellent",
        "value": 10,
        "data": {}
      }
    ],
    "data": {}
  })
})

Python

import requests

API_BASE_URL = 'https://addhuri.com/api/lib/feedback'
URL = f'{API_BASE_URL}/ratingScore'
POSTER_API_KEY = 'YOUR_POSTER_API_KEY'

headers = {
  'Content-Type': 'application
  'x-api-key-poster': POSTER_API_KEY
}
data = {
  "question": "Rate the quality of the API",
  "options": [
    {
      "text": "Excellent",
      "value": 10,
      "data": {}
    },
    {
      "text": "Good",
      "value": 5,
      "data": {}
    },
    {
      "text": "Average",
      "value": 0,
      "data": {}
    }
  ],
  "selectedOptions": [
    {
      "text": "Excellent",
      "value": 10,
      "data": {}
    }
  ],
  "data": {}
}

response = requests.post(URL, headers=headers, json=data)

cURL

curl -X POST "https://addhuri.com/api/lib/feedback/ratingScore" \
-H "Content-Type: application/json" \
-H "x-api-key-poster: YOUR_POSTER_API_KEY" \
-d '{
  "question": "Rate the quality of the API",
  "options": [
    {
      "text": "Excellent",
      "value": 10,
      "data": {}
    },
    {
      "text": "Good",
      "value": 5,
      "data": {}
    },
    {
      "text": "Average",
      "value": 0,
      "data": {}
    }
  ],
  "selectedOptions": [
    {
      "text": "Excellent",
      "value": 10,
      "data": {}
    }
  ],
  "data": {}
}'

GET API

This GET request can be used to retrieve records from the Feedback API.

Request Endpoint

GET /ratingScore

Request Headers

Use the master API key in the request headers to authenticate the request.

{
  "Content-Type": "application/json",
  "x-api-key-master": "YOUR_MASTER_API_KEY",
}

Request Query Parameters

Use the following query parameters to retrieve records from the Feedback API.

GET /ratingScore?page=1&limit=10

Parameter	Type	Default	Min	Max	Description
page	number	1	1	-	The page number to retrieve.
limit	number	10	1	100	The number of items to retrieve per page.

Response Body

The response will contain an array of Rating Score.

{
  "data": [
    {
      "type": "RatingScore",
      "id": "9b7f1037-3fd7-48e4-96d6-c8ec2aee6a50",
      "createdAt": "2025-01-05T12:29:39.103Z",
      "updatedAt": "2025-01-05T12:29:39.103Z",
      "question": "Rate the quality of the API",
      "options": [
        {
          "text": "Excellent",
          "value": 10,
          "data": {}
        },
        {
          "text": "Good",
          "value": 5,
          "data": {}
        },
        {
          "text": "Average",
          "value": 0,
          "data": {}
        }
      ],
      "selectedOptions": [
        {
          "text": "Excellent",
          "value": 10,
          "data": {}
        }
      ],
      "data": {}
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 1,
  "totalPages": 1,
  "message": "",
  "status": "success"
}

Example

Here is an example of how to submit a Rating Score to the Feedback API using different programming languages and tools.

JavaScript

const API_BASE_URL = 'https://addhuri.com/api/lib/feedback'
const URL = `${API_BASE_URL}/ratingScore`
const MASTER_API_KEY = 'YOUR_MASTER_API_KEY'

fetch(URL, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key-master': MASTER_API_KEY
  }
})

Python

import requests


API_BASE_URL = 'https://addhuri.com/api/lib/feedback'
URL = f'{API_BASE_URL}/ratingScore'
MASTER_API_KEY = 'YOUR_MASTER_API_KEY'

headers = {
  'Content-Type': 'application
  'x-api-key-master': MASTER_API_KEY
}

response = requests.get(URL, headers=headers)

cURL

curl -X GET "https://addhuri.com/api/lib/feedback/ratingScore" \
-H "Content-Type: application/json" \
-H "x-api-key-master: MASTER_API_KEY"