Customer Events

Section: Group Customer Events. Base URL: https://instance_name.meiro.io/api/.

Customer Events [/customers/{customer_entity_id}/events{?limit,offset,order_by,order_dir,tag_ids,source_ids,event_ids,show_hidden,start_date,end_date,search_text,load_full_structure}]

List All Customer Events [GET]

Required feature: customers/detail

• Parameters

  • limit (number, optional) - Limit of the number of records returned
  • offset (number, optional) - Offset for the number of records returned
  • order_by (string, optional) - Ordered column name
  • order_dir (string, optional) - Ordering direction
  • source_ids (array, optional) - Events' sources filter
  • event_ids (array, optional) - Events filter
  • show_hidden (integer, optional) - Result will include hidden events if set to 1
  • start_date (datetime, optional) - Start date in format YYYY-MM-DD hh:mm:ss
  • end_date (datetime, optional) - End date in format YYYY-MM-DD hh:mm:ss
  • search_text (string, optional) - Search text in event payload
  • load_full_structure (number, optional) - Full data structure return flag

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customer_events": [
        {
            "id": 100,
            "customer_entity_id": 200,
            "event_id": 300,
            "source_id": 400,
            "event_time": "2017-01-01T15:35:00Z",
            "type": "type example",
            "version": "1.0",
            "payload": "payload example",
            "created": "2017-01-01T15:35:00Z"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "event_ids": null,
        "source_ids": ["300"],
        "show_hidden": false,
        "start_date": "2017-01-01 00:00:00",
        "end_date": "2017-01-02 00:00:00"
    }
}

Customer Events Count [/customer_events_count{?start_date,end_date}]

Get Total Number of Customer Events [GET]

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customer_events_count": 4
}

Customer Events Count Including Hidden [/licence_usage_counts]

Get Total Number of Customer Events Including Hidden [GET]

Required feature: data/licence_usage

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customer_events_hidden_included_count": 4,
    "customer_events_hidden_included_last_30_days_count": 1
}

Events Per Customer Count [/events_per_customer_count]

Get Number of Events Per Customer [GET]

Required feature: data/dashboard

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "events_per_customer_count": 4
}

Events Per Event Type Count [/customer_events_per_event_type]

Get Number of Events Per Event Type [GET]

Required feature: data/dashboard

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customer_events_per_event_type": [
        {
            "source_id": "1",
            "event_type": "page_viewed",
            "count": 200
        }
    ]
}

Events Per Date Count [/customer_events_per_date{?start_date,end_date}]

Get Number of Events Per Date [GET]

Required feature: data/dashboard

• Parameters

  • start_date (datetime, optional) - Start date in format YYYY-MM-DD
  • end_date (datetime, optional) - End date in format YYYY-MM-DD

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customer_events_per_date": [
        {
            "source_id": "1",
            "events_per_date": [
                {
                    "date": "2017-01-01",
                    "count": 200
                }
            ]
        }
    ],
    "resolution": "day",
    "selection_settings": {
        "start_date": "2017-01-01",
        "end_date": "2017-01-02"
    }
}

Customers Per Source Count [/customers_per_source]

Get Count of Customers Per Source [GET]

Required feature: data/dashboard

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customers_per_source": [
        {
            "source_id": "1",
            "count": 24
        }
    ]
}

Customers Count Per Source Count [/customers_per_sources_count]

Get Count of Customers Per Source Count [GET]

Required feature: data/dashboard

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customers_per_sources_count": [
        {
            "source_count": 1,
            "source_values": [
                {
                    "source_ids": ["1"],
                    "customers_count": 35
                }
            ]
        }
    ]
}

Last Event Times [/last_event_times]

Get Last Event Times [GET]

Required feature: data/dashboard

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "last_event_times": [
        {
            "event_id": "c9981c3a-4cf4-44db-8eb0-c21b460fd7a8",
            "last_event_time": "2017-01-01 00:00:00"
        }
    ]
}

Customers With Events Count Excess [/customers_with_events_excess]

Get Customers With Events Count Excess [GET]

Required feature (one of):

• data/dashboard

• segments/create

• foreign_segments/view

• foreign_segments/edit

• data/insights

• access to any segment

• Request (application/json)

  • Headers

    X-Access-Token: 1234567890abcdef

• Response 200 (application/json)

{
    "customers_with_events_excess": [
        {
            "customer_entity_id": "c9981c3a-4cf4-44db-8eb0-c21b460fd7a8",
            "events_count": 20000
        }
    ],
    "total_count": 256
}