Get Restriction Type

Endpoint to get a specific restriction type.

GET /public/v1/campaign-service/restriction-types/{restriction-type-id}

Try it

Get Restriction Type

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/restriction-types/{restriction-type-id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "interactionType": "impressions",
  "frequencyType": "daily",
  "level": "campaign"
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Path Parameters

restriction-type-id · integer · required

Restriction type ID.

Response

200

application/json

Successful Response

The type of restriction.

id · integer · required

The ID of the restriction.

interactionType · enum<string> · required

The interaction type of the restriction.

Available options: impressions, clicks, conversions

frequencyType · enum<string> · required

The frequency type of the restriction.

Available options: daily, weekly, monthly

level · enum<string> · required

The level of the restriction.

Available options: campaign, bid