Skip to content
API Reference
/
catalog
/
catalog_reviews_course_info_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_reviews_course_retrieve

Request

Retrieve a paginated list of course reviews with filtering options

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-empty

Filter reviews by course ID

orgstringnon-empty

Alias for platform_org

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Filter reviews by platform key

platform_orgstringnon-empty

Filter reviews by platform organization

sortstringnon-empty

Field to sort results by (default: '-id')

Default "-id"
user_idstringnon-empty

Filter reviews by user ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/course/?course_id=string&org=string&page=0&page_size=0&platform_key=string&platform_org=string&sort=-id&user_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Total number of reviews

next_pageinteger or nullrequired

Next page number

previous_pageinteger or nullrequired

Previous page number

resultsArray of objectsrequired
results[].​property name*anyadditional property
Response
application/json
{
  "count": 0,
  "next_page": 0,
  "previous_page": 0,
  "results": [
    { … }
  ]
}

catalog_reviews_course_info_retrieve

Request

Retrieve aggregate review information for a course.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

The course ID to get review information for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/course/info/?course_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
course_idstringrequired

The course ID associated with the reviews

avg_ratingnumber or null(double)required

Average rating of the course

countintegerrequired

Total number of reviews for the course

Response
application/json
{
  "course_id": "string",
  "avg_rating": 0.1,
  "count": 0
}

catalog_reviews_course_update_create

Request

Create or update a course review

Security
PlatformApiKeyAuthentication
Body
required
course_idstringrequired

The course ID to review

usernamestringrequired

The username of the reviewer

user_idinteger

The user ID of the reviewer (alternative to username)

ratingnumber or null(double)

The rating value (typically 1-5)

titlestring

The review title

contentstring

The review content/text

visibleboolean

Whether the review is visible

Default true
metadataany

Additional review metadata

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/course/update/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": "string",
    "username": "string",
    "user_id": 0,
    "rating": 0.1,
    "title": "string",
    "content": "string",
    "visible": true,
    "metadata": null
  }'

Responses

Bodyapplication/json
user_idintegerrequired

User ID of the reviewer

course_idstring
usernamestringrequired

Username of the reviewer

contentstringrequired

Review content

ratingnumber or null(double)required

Review rating

titlestringrequired

Review title

visiblebooleanrequired

Whether review is visible

createdstring(date-time)required

Review creation date

modifiedstring(date-time)required

Review modification date

metadataanyrequired
Response
application/json
{
  "user_id": 0,
  "course_id": "string",
  "username": "string",
  "content": "string",
  "rating": 0.1,
  "title": "string",
  "visible": true,
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "metadata": null
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com