Retrieve organization campaign events

get

https://api.gainfully.com/v1.0/events/?event=organization_campaign

Query Params

event

string

enum

required

Required parameter used to specify what type of events to retrieve

fields

string

Specify which fields to retrieve for each event

filter__timestamp__gt

int32

Filter events by a minimum timestamp

filter__timestamp__lt

int32

Filter events by a maximum timestamp

relative_xdays

int32

Used to specify a time period to retrieve events from ( events from the last x number of days, up to 90, starting with the current timestamp )

offset

number

Starting position of the query in relation to the complete set of unpaginated items.

limit

integer

Number of objects to retrieve in the response. By default, the value is the maximum, which is 100.

filter__action

string

enum

Filter events by action name.

Allowed:

filter__scource

string

enum

Filter the events by the source.

Allowed:

filter__recipient_email

string

Filter the events by the recipient's email address. Please note, the email address needs to be URL encoded.

filter__campaign_id

number

Filter the events by the id of the campaign.

filter__sender_id

number

Filter the events by the id of the sender.

ordering

string

enum

Sort the results by the specified fields. By default, the results are sorted by timestamp, i.e., the oldest ones come first. To sort the results in the reverse order of a field, the field name must be preceded with the - sign. To sort the results by multiple fields, the field names must be separated by commas.

Allowed:

Response

Language

Credentials

Header

Response

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

application/json

200Success!