Guides

Time Series

This endpoint gives a defined time series response for a given input email.

curl -X POST \
  https://api.fideo.ai/beta/signals/patterns/timeseries  \
  -H 'Authorization: Bearer {Your API Key}' \
  -H "Content-Type: application/json" \
  -d '{
      "email" : "[email protected]"
      "interval" : "month",
      "count" : 6
  }'
{
    "2024-09-01": {
        "hits": 6,
        "sources": 3
    },
    "2024-08-01": {
        "hits": 1,
        "sources": 1
    },
    "2024-07-01": {
        "hits": 1,
        "sources": 1
    },
    "2024-06-01": {
        "hits": 2,
        "sources": 2
    },
    "2024-05-01": {
        "hits": 1,
        "sources": 1
    },
    "2024-04-01": {
        "hits": 1,
        "sources": 1
    }
}

The above request will give the number of times and number of sources Fideo has seen the email [email protected] in the last 6 months.


A request will three attributes in the request:

  • An input plaintext email (Note: email hashes are NOT supported)
  • A desired interval. Se the interval table below for valid intervals.
  • The count of how many data points. This value willl be the most recent data points for that interval.

All dates and times are returned in the UTC time zone.


Supported Interval and Counts

Interval TypeMinimum CountMaximum CountOutput Key Format
minute1360yyyy-MM-dd HH:mm:00
hour136yyyy-MM-dd HH:00:00
day160yyyy-MM-dd 00:00:00
month124yyyy-MM-01

Note -- the zeros ("00") above in the output key format reflect that these values are always zero. Similarly for the month, the day will always be "01". This was done to minimize the need to parse different key format.

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