Skip to main content

Gets the summary for the event count for a specific identity

GET 

/historical-identities/:id/snapshot-summary

This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read'

Request

Path Parameters

    id stringrequired

    The identity id

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Query Parameters

    before string

    The date before which snapshot summary is required

    Example: 2007-03-01T13:00:00Z
    interval string

    Possible values: [day, month]

    The interval indicating day or month. Defaults to month if not specified

    time-zone string

    The time zone. Defaults to UTC if not provided

    Example: UTC
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Responses

A summary list of identity changes in date histogram format.

Schema

  • Array [

  • name string

    the name of metric

    value number

    the value associated to the metric

  • ]

Loading...