Customer.io
v1.0.0
OpenAPI 3.1.0

Lookup a customer's activities

US region

Client Libraries
Shell Curl

Lookup a customer's activities

​

Return a list of activities performed by, or for, a customer. Activities are things like attribute changes and message sends.

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.

Path Parameters
  • customer_id
    Type: string
    required

    The ID of the customer you want to perform an operation against.

Query Parameters
  • id_type
    Type: stringenum

    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.

    values
    • id
    • email
    • phone
    • cio_id
  • start
    Type: string

    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.

  • limit
    Type: integer
    max:  
    100

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

  • type
    Type: stringenum

    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.

    values
    • add_relationship
    • anon_merge
    • attempted_action
    • attempted_email
    • attempted_in_app
  • name
    Type: string

    For event and attribute_update types, you can search by event or attribute name respectively.

Responses
  • application/json
  • 400

    The request parameters are malformed.

  • 404

    The customer_id does not exist.

  • 429

    Your request is over the 10-per-second limit.

Request Example for get/v1/customers/{customer_id}/activities
curl 'https://api.customer.io/v1/customers/12345/activities?id_type=id&start=&limit=10&type=add_relationship&name=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "activities": [
    {
      "customer_id": "42",
      "customer_identifiers": {
        "email": "test@example.com",
        "id": 2,
        "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",
      "name": "string",
      "url": "string"
    }
  ]
}

Returns an array of activity objects. Each object represents an activity that the customer performed, or that you performed on behalf of the customer.