API Reference
Start typing to search…

Gets query matches by query string.

get https://developers.emysound.com/api/v1.1/Matches
Log in to see full request history
Query Params
string

Query string used to filter query matches (default "").
This filter will search in the following AVQueryMatches fields: Id, Track.Id, Track.Title, Track.Artist.
Empty string will match all query matches.

int32
Defaults to 50

Limit how many query matches to return.

date-time

Min date using ISO8601 format, inclusive.

date-time

Max date using ISO8601 format, exclusive.

string

Provides means of treating from/to parameters as point or range queries.
PointQuery: AVQueryMatch is treated as a point in time (an event that happened at matchedAt unix timestamp) and only those points that are within from/to points are returned to the caller.
RangeQuery: AVQueryMatch is treated as a time range (an event that happened at matchedAt for matchedAt + trackDiscreteCoverageLength seconds) and those points that are within, intersects, or contain from/to points are returned to the caller.

string

Cursor used in paginating, when "" is provided the first page of the results will be returned.

facets
array of strings

Facets to return. Supported facets: trackId, streamId, mediaType, reviewStatus.

facets
intervalFacets
array of strings

Interval facets to return. Supported intervals: matchedAt. matchedAt is an interval facet that is provided with low (inclusive) and high (exclusive) range values measured in Unix Epoch seconds, that will count matches within that range.

intervalFacets
intervalFacetStartsAt
array of int64s

Interval facet starts at value, ordinal corresponding to interval facets parameter.
Example: intervalFacetStartsAt=1640995200.

intervalFacetStartsAt
intervalFacetEndsAt
array of int64s

Interval facet ends at value, ordinal corresponding to interval facets parameter.
Example: intervalFacetEndsAt=1641081600.

intervalFacetEndsAt
intervalFacetCount
array of int64s

Interval facet step, used to generate interval facets between intervalFacetStartsAt and intervalFacetEndsAt values.
Example: 1000.

intervalFacetCount
facetValuesLimit
array of strings

Maximum values to return per facet, encoded in the format facetName:limit.

Default value is 2048.

facetValuesLimit
facetValuesOffset
array of strings

Facet values offset, used to provide pagination to results with large number of facet values, encoded in the format facetName:offset.

Default value is 0.

facetValuesOffset
boolean
Defaults to false

A flat indicating whether to include facet values with zero count in the result set or not.

string

Specifies how to order facet values in the result set.

filters
array of strings

Filters used to filter the query results. Returned facets can be used as filters to filter query results.
To filter results by streamId specify it in the following format 'streamId:queryValue'. The logic used between multiple filters is between same is OR, otherwise AND.

Example 1: filters=streamId:CNN - will return matches registered on CNN stream only.

Example 2: filters=streamId:CNN&filters=mediaType:Video - will return Video matches registered on CNN stream only.

Facet value counts are not affected by applied filters, since faceting is counted sideways (s.t. non-selected filters can stay visible even when filters are applied on search results page).

filters
facetFilters
array of strings

Facet filters used to filter facet results. To drill down the set of facets use provided query parameter.

Example 1: facets=trackId&facetFilters=trackId:123 - will return facet counts only for track 123.

You can filter only those facets that are provided in the facets query parameter.

facetFilters
Headers
string
Defaults to */*

In case you want to export matches in various formats, provide Accept HTTP header with requested value.
Supported values: text/csv.

If not specified, or unsupported value is requested JSON data will be returned from the endpoint.

Responses

500

Something went wrong. Contact support.

Updated over 1 year ago

Language
Credentials
:
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago