CUcustomer
Activities

List activities

Changed on

This endpoint returns a list of "activities" for people, similar to your workspace's Activity Logs. This endpoint is guaranteed to return activity history within the past 30 days. It might return data older than 30 days in some circumstances, but activites older than 30 days are not guaranteed.

get/v1/activities

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/activities
  • Auth
    HTTP bearer

Query parameters

startstring

The token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.

type'add_relationship' | 'anon_merge' | 'attempted_action' | 'attempted_email' | 'attempted_in_app' | 'attempted_push' | 'attempted_slack' | 'attempted_twilio' | 'attempted_webhook' | 'attempted_whatsapp' | 'attribute_change' | 'bounced_action' | 'bounced_email' | 'bounced_push' | 'bounced_twilio' | 'bounced_whatsapp' | 'clicked_action' | 'clicked_content' | 'clicked_email' | 'clicked_in_app' | 'clicked_push' | 'clicked_twilio' | 'clicked_webhook' | 'consent' | 'converted_action' | 'converted_content' | 'converted_email' | 'converted_in_app' | 'converted_slack' | 'converted_twilio' | 'converted_webhook' | 'converted_whatsapp' | 'deferred_action' | 'deferred_email' | 'deferred_in_app' | 'deferred_push' | 'deferred_slack' | 'deferred_twilio' | 'deferred_webhook' | 'deferred_whatsapp' | 'delete_relationship' | 'delivered_action' | 'delivered_email' | 'delivered_push' | 'delivered_twilio' | 'delivered_whatsapp' | 'device_change' | 'drafted_action' | 'drafted_email' | 'drafted_in_app' | 'drafted_push' | 'drafted_slack' | 'drafted_twilio' | 'drafted_webhook' | 'dropped_action' | 'dropped_email' | 'dropped_push' | 'dropped_twilio' | 'dropped_webhook' | 'dropped_whatasapp' | 'event' | 'failed_action' | 'failed_attribute_change' | 'failed_batch_update' | 'failed_email' | 'failed_event' | 'failed_in_app' | 'failed_object_journeys' | 'failed_push' | 'failed_query_collection' | 'failed_slack' | 'failed_twilio' | 'failed_webhook' | 'failed_whatsapp' | 'opened_action' | 'opened_email' | 'opened_in_app' | 'opened_push' | 'page' | 'profile_create' | 'profile_delete' | 'profile_merge' | 'relationship_attribute_change' | 'relationship_failed_attribute_change' | 'screen' | 'sent_action' | 'sent_email' | 'sent_in_app' | 'sent_push' | 'sent_slack' | 'sent_twilio' | 'sent_webhook' | 'sent_whatsapp' | 'skipped_update' | 'spammed_email' | 'suppressed_twilio' | 'suppressed_whatsapp' | 'topic_unsubscribed_email' | 'undeliverable_action' | 'undeliverable_email' | 'undeliverable_in_app' | 'undeliverable_push' | 'undeliverable_slack' | 'undeliverable_twilio' | 'undeliverable_webhook' | 'undeliverable_whatsapp' | 'unsubscribed_action' | 'unsubscribed_email' | 'viewed_content' | 'webhook_event' | '_o:<object_type_id>:add_relationship' | '_o:<object_type_id>:attribute_change' | '_o:<object_type_id>:create' | '_o:<object_type_id>:delete' | '_o:<object_type_id>:delete_relationship' | '_o:<object_type_id>:failed_attribute_change' | '_r:<object_type_id>:attribute_change' | '_r:<object_type_id>:failed_attribute_change'

The type of activity. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.

Example:sent_email

The type of activity you want to search for. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.

namestring
Example:something_happened

The name of the event or attribute you want to return. For consent activities, the consent action, like opted_in or opted_out.

deletedboolean

If true, return results for deleted people.

customer_idstring

The identifier of the person you want to look up. By default, this is a person's id. You can use the id_type parameter to look up a person by email, phone, or cio_id.

If you use a person's cio_id, you must prefix the value with cio_ when using it to find or reference a person (i.e. cio_03000010 for a cio_id value of 03000010).

id_type'id' | 'email' | 'phone' | 'cio_id'

The type of customer_id you want to use to reference a person. If you don't provide this parameter, we assume that the customer_id in your request is a person's id. You can use email and phone only if they're enabled as identifiers in your workspace settings; otherwise the request returns 400. Reference phone values in E.164 format, like +14155552671, and URL-encode the leading + as %2B.

limitinteger

The maximum number of results you want to retrieve per page.

Response

Returns an array of activities.

nextstring

Indicates the next page of results. Add ?start=<next_value> to the request to get the next page of results.

Example response

{
  "activities": [
    {
      "customer_id": "42",
      "customer_identifiers": {
        "email": "test@example.com",
        "cio_id": "a3000001"
      },
      "data": {
        "delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
        "opened": null,
        "delivered": null
      },
      "delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
      "delivery_type": "email",
      "id": "01AK4N8V8G8KVA4HN8Y50CCZ59",
      "timestamp": 1397566226,
      "type": "sent_email"
    }
  ]
}

Changes

  • 400114d2b5e0Revision changes
    • breaking

      added subschema #3: Consent record to the // response property oneOf list for the response status

    • warning

      added the new consent enum value to the // response property for the response status

    • info

      added the new enum value consent to the query request parameter type

  • 5da2740beeb5Revision changes
    • info

      added the media type application/json for the response with the status