Get Matches

Returns stream matches from a monitor configured in your Aiera desktop.

GET /dashboards/{dashboard_guid}/streams/{stream_guid}/matches

Parameter	Type	DataType	Description
dashboard_guid	path	uuid	The ID of the monitor to fetch the results from, found in Aiera Desktop
stream_guid	path	uuid	The ID of the search stream in the monitor, found in Aiera Desktop
start_date	query	datetime	Get matches on or after this date (defaults to 12 weeks ago)
end_date	query	datetime	Get matches on or before this date (defaults to now)
linguistics	query	boolean	Whether to include linguistics metadata in the response
collapse	query	boolean	Whether to collapse results (defaults to true)
collapse_size	query	integer	Size of collapsed results (defaults to 5)
next_page_token	query	string	Pagination token returned with each result. Cannot be used with collapse=true
from_index	query	integer	The index to return results from - combine with size to page results
size	query	integer	The number of matches to return

Response

{
  "total": 10000,
  "size": 100,
  "next_page_token": "WzE2MTk3MzAyOTUwMDAsICI0NjA5NTEyNSJd",
  "results": [
    {
      "item_id": 46164695,
      "type": "transcript",
      "highlights": [
        "<em class=\"annotate_term_match\">Vacation</em> a little painful for another."
      ],
      "event": {
        "event_id": 10045,
        "title": "Q4 2021 AU Small Finance Bank Ltd Earnings Call",
        "date": "2021-04-30T00:00:00-04:00",
        "event_type": "earnings",
        "equity": {
          "equity_id": 49398,
          "ticker": "540611",
          "mic": "XBOM",
          "bloomberg_ticker": "540611:IN",
          "isin": "INE949L01017",
          "gics_sector": "Financials",
          "gics_sub_sector": "Regional Banks"
        }
      }
    }
  ]
}

Code Samples

Bash

curl --request GET \
  --url 'https://premium.aiera.com/api/dashboards/{dashboard_guid}/streams/{stream_guid}/matches' \
  --header 'X-API-Key: xxx'

Python

import requests
requests.get("https://premium.aiera.com/api/dashboards/{dashboard_guid}/streams/{stream_guid}/matches", headers={"X-API-Key": "xxx"})