v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Reviews

Retrieves the campaign with the specified id.

get/dashboards/{dashboard_id}/campaigns/{campaign_id}

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

campaign_idinteger required

Id of campaign

Response

The campaign's details.

idinteger

The campaign identifier. Required to update or delete campaigns.

namestring

Name of the campaign.

base_linkstring uri

The generic url to give to customers to leave a review using Text Request's reviews system. This url is not a customized URL, like the kind that is generated when sending review requests in texts, so reviews left using a generic url cannot be tracked back to the customer (and so be marked as "requested").

date_createdstring date-time

Timestamp of when the review was left.

is_archivedboolean

Whether the campaign is archived.

Example response

{
  "id": 508,
  "name": "First-time Customers Reviews",
  "base_link": "enter-url-here"
}