Contact Activities (Events)

API Set Name: contactactivities

• POST /contactactivities
• Parameters
• Example JSON requests
• Example request URIs
• GET /contactactivities
• Parameters
• Paging and retrieval limits
• Example request URIs
• Error Responses

API Description and Functional Purpose:

The contact activities collection contains all contact-related activities, such as opens, clicks, sends and any other custom actions you create. Contact activities are also referred to as "events".

Additional information:

• Contact activities are associated to the contact via the contact's primary or secondary identifier keys. Default primary and secondary contact identifier keys can be configured uniquely for each Cordial account based on the client's data infrastructure.
• A contact can have multiple contact activities documenting various action types.
• Actions taken within a message (reserved actions) will automatically generate an activity record. These include:
  • message-sent
  • open
  • click
  • optout
  • bounce
  • complaint
  • pageview
  • message-stopped
• You can also create custom event activities such as "browse", "order", "cart", etc.
• Custom event activities can be added and acted upon through contact activities records in the Cordial database.
• Contact activity data will be stored for 18 months, after which it will be systematically purged.

Resource associations:

The following resource collections are associated to this collection.

POST /contactactivities

Parameters

* Required

Example JSON requests

The following will create a new contact activity record for a user-defined "browse" event.

{
    "a": "browse",
    "email": "msmith@example.com",
    "ats": "2018-01-09 17:47:43",
    "properties": {
        "category": "Shirts",
        "url": "http://example.com/shirts",
        "description": "A really cool khaki shirt.",
        "price": 9.99,
        "title": "Khaki Shirt"
    }
}

Example request URIs

The following URI in conjunction with the JSON will perform the POST.

http://<path>/contactactivities

GET /contactactivities

Parameters

* Required

Paging and retrieval limits

The GET /contactactivities endpoint can retrieve up to 10,000 records at a time. You can request all 10,000 records on a single page and use the provided URI with the paging token to query the next batch. The paging URI will appear as the first JSON object in your results when there are more records to show.

"paging": {
    "token": "5bbbbb56c4605038b4567",
    "next": "http://<path>/v2/contactactivities?per_page=10000&return_count=false&__paging_token=5bbbbb56c4605038b4567"
  }

Example request URIs

The following URI will retrieve all contact activities.

http://<path>/contactactivities

The following URI will retrieve all contact activities where the email address "msmith@example.com" is the contact identifier.

http://<path>/contactactivities?email=msmith@example.com

The following URI will retrieve all contact activities where the action is "browse".

http://<path>/contactactivities?action=browse

The following URI will retrieve all contact activities where the action is "browse" and email address "msmith@example.com" is the contact identifier.

http://<path>/contactactivities?action=browse&email=msmith@example.com

The following URI will retrieve all contacts but only include the contact activities that have occurred between the specified start date and end date.

http://<path>/contactactivities?time[between][start]=2018-01-01&time[between][end]=2018-01-03

The following URI will retrieve all contacts but only include the "open" contact activities that have occurred between the specified start date and end date.

http://<path>/contactactivities?time[between][start]=2018-01-01&time[between][end]=2018-01-03&action=open

The following URI will retrieve all contact activities starting from the 3rd page and grouping contact activities by 10 per page. For example, page 1 would have included the first 10, page 2 the second group of 10 and so on. Note: The default per_page value is 25.

http://<path>/contactactivities?page=3&per_page=10

The following URI will return a count of all contact activities in the request:

http://<path>/contactactivities?return_count=true

Error Responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Contact Activities API endpoint, along with suggested modifications to resolve each error. If you receive an error from the Jobs API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses page.