Skip to content
API Reference
/
catalog
/
catalog_reviews_program_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_update_destroy

Request

Delete a course review

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

The course ID of the review to delete

user_idinteger

The user ID of the reviewer (alternative to username)

usernamestringnon-emptyrequired

The username of the reviewer

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/course/update/?course_id=string&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Review successfully deleted

catalog_reviews_program_retrieve

Request

Retrieve a paginated list of program reviews with filtering options

Security
PlatformApiKeyAuthentication
Query
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

program_idstringnon-empty

Filter reviews by program ID

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/program/?org=string&page=0&page_size=0&platform_key=string&platform_org=string&program_id=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 objects(ProgramReview)required

List of program reviews

results[].​user_idintegerrequired

The user identifier

results[].​usernamestringrequired

The username of the reviewer

results[].​contentstringrequired

Review content/text

results[].​ratingnumber or null(double)required

Rating value (typically 1-5)

results[].​titlestringrequired

Review title

results[].​visiblebooleanrequired

Whether the review is visible

results[].​createdstring or nullrequired

Date when review was created

results[].​modifiedstring or nullrequired

Date when review was last modified

results[].​program_keystringrequired

The program key identifier

Response
application/json
{
  "count": 0,
  "next_page": 0,
  "previous_page": 0,
  "results": [
    { … }
  ]
}

catalog_reviews_program_info_retrieve

Request

Retrieve aggregate review information for a program.

Security
PlatformApiKeyAuthentication
Query
program_keystringnon-emptyrequired

The program key to get review information for

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

Responses

Bodyapplication/json
program_keystringrequired

The program key associated with the reviews

avg_ratingnumber or null(double)required

Average rating of the program

countintegerrequired

Total number of reviews for the program

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

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