Retrieves a rating campaign by id.
const url = 'https://example.com/api/v1/provision/admin/rating-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/provision/admin/rating-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”OK
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, only if they are entitled to that feature, and, when the campaign names offers, only if their entitlement was made from one of them.
object
True when the campaign is enabled and the current time is inside its window.
A campaign target as returned by the admin API, denormalized with the feature’s display fields.
object
Question shown for this feature; null or empty falls back to the generic prompt.
Lower is asked first. Null means no set order — reached by recent usage only.
The offers whose customers are asked. Empty asks every customer.
An offer whose customers a campaign asks, with the offer’s name and version.
object
The offer. A customer is one of its customers when their entitlement was made from it.
The offer’s name; null when the offer no longer exists.
The offer’s version.
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, only if they are entitled to that feature, and, when the campaign names offers, only if their entitlement was made from one of them.
object
True when the campaign is enabled and the current time is inside its window.
A campaign target as returned by the admin API, denormalized with the feature’s display fields.
object
Question shown for this feature; null or empty falls back to the generic prompt.
Lower is asked first. Null means no set order — reached by recent usage only.
The offers whose customers are asked. Empty asks every customer.
An offer whose customers a campaign asks, with the offer’s name and version.
object
The offer. A customer is one of its customers when their entitlement was made from it.
The offer’s name; null when the offer no longer exists.
The offer’s version.
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "isRunning": true, "targets": [ { "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "featureCode": "example", "featureName": "example", "question": "example", "priority": 1 } ], "offers": [ { "offerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "version": "example" } ], "creationTimeStamp": "2026-04-15T12:00:00Z", "lastUpdateTimeStamp": "2026-04-15T12:00:00Z", "revisionNumber": 1}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, only if they are entitled to that feature, and, when the campaign names offers, only if their entitlement was made from one of them.
object
True when the campaign is enabled and the current time is inside its window.
A campaign target as returned by the admin API, denormalized with the feature’s display fields.
object
Question shown for this feature; null or empty falls back to the generic prompt.
Lower is asked first. Null means no set order — reached by recent usage only.
The offers whose customers are asked. Empty asks every customer.
An offer whose customers a campaign asks, with the offer’s name and version.
object
The offer. A customer is one of its customers when their entitlement was made from it.
The offer’s name; null when the offer no longer exists.
The offer’s version.
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "isRunning": true, "targets": [ { "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "featureCode": "example", "featureName": "example", "question": "example", "priority": 1 } ], "offers": [ { "offerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "version": "example" } ], "creationTimeStamp": "2026-04-15T12:00:00Z", "lastUpdateTimeStamp": "2026-04-15T12:00:00Z", "revisionNumber": 1}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}