Skip to content
Integration Package/RubyPlay Public API/
/
Get Campaigns
Last updated

Get Campaigns

This endpoint retrieves a list of all campaigns.

API Call Sample:

curl -i -X GET \
  -u <username>:<password> \
  'https://asia.stage.rubyplay.io/api/v1/campaign?type=FREE_ROUNDS&name=test+campaign&externalCampaignId=new_test_campaign&startDateFrom=2023-04-16T13%3A56%3A39.492&startDateTo=2023-05-16T13%3A56%3A39.492&gameId=140&status=UPCOMING&paging.pageNumber=5&paging.pageSize=10&paging.sortBy=id&paging.order=ASCENDING'
Response
application/json
{
  "content": [
    {
      "id": 7,
      "type": "FREE_ROUNDS",
      "disabledAt": "2022-02-23T22:22:22Z",
      "status": "UPCOMING",
      "strategy": "FIRST_N_PLAYERS",
      "name": "New Year Promo",
      "externalCampaignId": "New Year Promo",
      "currencyCode": "UAH",
      "bet": 2.5,
      "betNumber": 77,
      "gameId": "7",
      "gameIds": [
        "rp_140"
      ],
      "startDateTime": "2022-02-21T22:22:22Z",
      "endDateTime": "2022-02-22T22:22:22Z",
      "eligiblePlayersNumber": 777,
      "accomplishedPlayersNumber": 555,
      "roundsGiven": 100,
      "roundsPlayed": 55,
      "optOutPlayersNumber": 5
    }
  ],
  "total": 0,
  "_metadata": {
    "pagingInfo": {
      "pageNumber": 5,
      "pageSize": 10,
      "sortBy": "id",
      "order": "ASCENDING"
    },
    "totalNumberOfElements": 0
  }
}

Query Parameters:

typestring

Default value FREE_ROUNDS if absent. Possible values: FREE_ROUNDS, AWARDED_FEATURE

Default "FREE_ROUNDS"
Enum"FREE_ROUNDS""AWARDED_FEATURE"
Example: "FREE_ROUNDS"
namestring

Campaign name

Example: "test campaign"
externalCampaignIdstring

External campaign ID.

Example: "new_test_campaign"
startDateFromstring(date)

Filters results to include items with a start date on or after this value.

startDateTostring(date)

Filters results to include items with a start date on or before this value.

gameIdinteger(int32)

Game ID.

Example: 140
statusstring

Possible values: UPCOMING, ONGOING, ENDED, DISABLED

Enum"UPCOMING""ONGOING""ENDED""DISABLED"
Example: "UPCOMING"
pagingobject(PagingInfo)

Response Schema:

contentArray of objects(CampaignViewDto)
totalinteger(int64)
_metadataobject(PagingMetadata)
Previous page
Next page