List goal completions

get

https://{youraccountname}.api-us1.com/api/3/contactGoals

Lists goal completions. Each record says that a contact reached a goal in an automation. A contact normally has one record for each goal in each run through an automation. The filters are exact matches, and filters on different fields must all match. Several orders parameters sort in the order given. Without one, the order of the records is not guaranteed. Page with limit and offset, or use ids to fetch specific records.

Query Params

limit

int32

Defaults to 20

Number of goal completions to return. Defaults to 20; values above 100 are treated as 100.

offset

int32

Defaults to 0

Number of goal completions to skip. Use with limit to page through the list.

ids

string

Comma-separated goal completion IDs to return. When set, limit does not apply, but offset still does.

filters[goalid]

int32

Return only completions of this goal ID.

filters[seriesid]

int32

Return only completions in this automation ID.

filters[subscriberid]

int32

Return only completions by this contact ID.

filters[subscriberseriesid]

int64

Return only completions in this run through an automation (a contactAutomation ID).

filters[timespan]

int32

Return only completions that took exactly this many seconds.

filters[tstamp]

string

Return only completions recorded at exactly this time, as YYYY-MM-DD HH:MM:SS in server local time. This is an exact match, not a range.

orders[goalid]

string

enum

Sort by goal ID. Case does not matter. Any value other than desc sorts ascending.

Allowed:

orders[seriesid]

string

enum

Sort by automation ID. Case does not matter. Any value other than desc sorts ascending.

Allowed:

orders[subscriberid]

string

enum

Sort by contact ID. Case does not matter. Any value other than desc sorts ascending.

Allowed:

orders[subscriberseriesid]

string

enum

Sort by contactAutomation ID. Case does not matter. Any value other than desc sorts ascending.

Allowed:

orders[timespan]

string

enum

Sort by the time the contact took to reach the goal. Case does not matter. Any value other than desc sorts ascending.

Allowed:

orders[tstamp]

string

enum

Sort by when the completion was recorded. Case does not matter. Any value other than desc sorts ascending.

Allowed:

Responses

403

The request has no valid API token. The body is empty.

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200A page of goal completions under contactGoals, with the number of matching records in meta.total.