Get campaigns

get

https://api.indigitall.com/v2/chat/{applicationId}/campaign

List all the campaigns and their details for a given application

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

integer

required

Application's ID

Query Params

limit

integer

1 to 100

Defaults to 25

Limit the number of campaigns returned

page

integer

≥ 0

Defaults to 0

Page number

orderBy

string

Defaults to createdAt-desc

Sorts the results by field and direction:

title-asc Order by title ascending. From A to Z.
title-desc Order by title descending. From Z to A.
createdAt-asc Order by creation date ascending.
createdAt-desc Order by creation date descending.
updatedAt-asc Order by last update date ascending.
updatedAt-desc Order by last update date descending.

enabled

boolean

Filter the campaigns by the enabled status:

true Return only enabled campaigns.
false Return only disabled campaigns.

If not provided, both enabled and disabled campaigns will be returned.

title

string

Filter the campaigns by title. The format is operator:value. Operators:

contains Returns campaigns with the word in the title.
equals Returns campaigns that are exactly the value.

Examples:

contains:day -> Returns campaigns with the word day in the title.
equals:day -> Returns campaigns that title is exactly day.

It's mandatory to encode URI components:

contains:day%20promo -> Returns campaigns with the text day promo in the title.

count

boolean

Defaults to false

Returns the number of campaigns that match the specified filter criteria. If set to true, the response will include the count property. If set to false, the response will only include the data property.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve information about all campaigns for a given application

403Forbidden

404Not found

500Internal server error