Historical Summary

The historical endpoint provides summaries over six different time ranges

curl -X POST \
  https://api.fideo.ai/beta/signals/patterns/summary  \
  -H 'Authorization: Bearer {Your API Key}' \
  -H "Content-Type: application/json" \
  -d '{
      "email" : "[email protected]"
  }'

{
    "hour": {
        "observations": 0,
        "sources": 0
    },
    "day": {
        "observations": 19,
        "sources": 4,
        "events": [
        {
       		 "type": "visitor",
       		 "observations": 16,
       		 "sources": 3
        },
        {
       		 "type": "id_resolution",
       		 "observations": 3,
           "sources": 1
        }
      ]
    },
    "week": {
        "observations": 107,
        "sources": 6,
        "events": [
        {
       		 "type": "visitor",
       		 "observations": 102,
       		 "sources": 5
        },
        {
       		 "type": "id_resolution",
       		 "observations": 5,
       		 "sources": 3
      	}
      ]
    },
    "month": {
        "observations": 478,
        "sources": 19,
        "events": [
        {
       		 "type": "visitor",
       		 "observations": 468,
       		 "sources": 16 
        },
        {
       		 "type": "id_resolution",
       		 "observations": 10,
       		 "sources": 3
      	}
      ]
    },
    "sixMonth": {
        "observations": 2167,
        "sources": 27,
        "events": [
        {
       		 "type": "visitor",
       		 "observations": 2140,
       		 "sources": 23
        },
        {
       		 "type": "id_resolution",
       		 "observations": 27,
       		 "sources": 4
      	}
      ]
    },
    "year": {
        "observations": 2727,
        "sources": 39,
        "events": [
        {
       		 "type": "visitor",
       		 "observations": 2700,
       		 "sources": 35
        },
        {
       		 "type": "id_resolution",
       		 "observations": 27,
       		 "sources": 4
      	 }
       ]
    }
}

The only input, is a single email attribute. Note email hashes are not supported.

Values will be returned for each of the intervals below:

hour (last 60 minutes)
day (last 24 hours)
week (last 7 days)
month (last 30 days)
sixMonth (last 6 months)
year (last 12 months)

For each interval in the response, two counts will be returned:

observations - the total number of times the particular email was seen in that pattern interval, across all sources
sources - the count of unique sources making these sources

events- details on each type of event as an array of objects. Possible values and details are below. For each event, a type, observation count, and source count is provided.

Event Type	Event Description
verification	Email was used in Fideo Verify or Signals APIs
visitor	Email was seen tied to a website visit event
signup	Email was used to sign up for an account
click	Email was seen through someone clicking a link, likely in an email
enrichment	Email was used to retrieve enrichment data
id_resolution	Email was used as Identity Resolution to tie the email to other identifiers

Note Each of the six intervals will always be returned regardless of if usage was seen over that time period or not.

Have suggestions or feedback on this Beta API? Please let us know!