RUrudder
Campaigns

Get campaign events for a campaign

Get campaign events for a campaign

get/campaigns/{id}/events

Request

Path parameters

idstring uuid required
Example:0076a379-f32d-4732-9e91-33ab219d8fde

Id of the campaign

Query parameters

campaignType'system-update' | 'software-update'
Example:system-update

Type of the campaigns we want

state'scheduled' | 'running' | 'finished' | 'skipped'
Example:running

Status of the campaign events we want

limitinteger

Max number of elements in response

offsetinteger

Offset of data in response (skip X elements)

beforestring date-time
afterstring date-time
order'start' | 'startDate' | 'end' | 'endDate'

The start or end date column to sort (with 'asc' for the ascending or descending order)

Example:start
asc'asc' | 'desc'

Response

Campaign details result

result'success' | 'error' required

Result of the request

action'getEventsCampaign' required

The id of the action

Example response

{
  "data": {
    "campaignEvents": [
      {
        "id": "0076a379-f32d-4732-9e91-33ab219d8fde",
        "name": "Update all systems #1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.