Skip to content
OclavexOclavex Docs

Lists rating campaigns with pagination, sorting, and filtering.

GET
/api/v1/provision/admin/rating-campaigns
curl --request GET \
  --url 'https://example.com/api/v1/provision/admin/rating-campaigns?pageNumber=1&pageSize=100'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
pageNumber
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/
pageSize
integer | string format: int32
default: 100 /^-?(?:0|[1-9]\d*)$/
sortOrder
string
filter
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.

object
pageNumber

The 1-based index of this page within the full result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pageSize

The maximum number of items per page that was requested.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalCount

The total number of items across all pages.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
items

The items on this page.

Array<object>

A rating campaign: a transient ask (“how is export working out this quarter?”) layered over the permanent feature catalog. A user is prompted about a targeted feature only while the campaign is running and only if they are entitled to that feature.

object
id
string format: uuid
name
string
description
null | string
isEnabled
boolean
startsAt
null | string format: date-time
endsAt
null | string format: date-time
isRunning

True when the campaign is enabled and the current time is inside its window.

boolean
targets
Array<object>

A campaign target as returned by the admin API, denormalized with the feature’s display fields.

object
featureCatalogId
string format: uuid
featureCode
string
featureName
string
question

Question shown for this feature; null or empty falls back to the generic prompt.

null | string
priority

Lower is asked first. Null means no set order — reached by recent usage only.

null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalPages

The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasPreviousPage

Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).

boolean
hasNextPage

Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).

boolean