api.clarify.io
  1. reports
api.clarify.io
  • bundles
    • List bundles
      GET
    • Create a bundle
      POST
    • Delete a bundle
      DELETE
    • Get a bundle
      GET
    • Update a bundle
      PUT
    • Get bundle insights
      GET
    • Request an insight to be run
      POST
    • Get bundle insight
      GET
    • Delete bundle metadata
      DELETE
    • Get bundle metadata
      GET
    • Update bundle metadata
      PUT
    • Delete bundle tracks
      DELETE
    • Get bundle tracks
      GET
    • Add a track for a bundle
      POST
    • Update a tracks for a bundle
      PUT
    • Delete a bundle track
      DELETE
    • Get bundle track
      GET
    • Add media to a track
      PUT
  • reports
    • Generate Group Report <span class="label">beta</span>
      GET
    • Generate Trends Report <span class="label">beta</span>
      GET
  • search
    • Search bundles
      GET
  1. reports

Generate Trends Report <span class="label">beta</span>

GET
/v1/reports/trends

Analyzes bundle content over a series of time periods and generates a trend report.

interval specifies the duration of each time period in the report. For example, you can generate a report that gives monthly statistics. If there are no bundles for a given period, that period will not be present in the report.

content specifies the content type to analyze and include in the report. These can include tracks and insights. Multiple values can be specified to generate a rich report. If content is not specified, only bundle counts are included in the report.

filter is used to limit the bundles in the report according to specific criteria based on metadata and bundle values. A report filter behaves in the same way as a search filter. It uses an expression syntax similar to Javascript boolean expressions. An expression is made up of zero or more terms joined by logical operators with each term having a field, a comparison operator, and a literal value. Parentheses can be used to logically group terms.

A filter term is of the form: field-name comparison-operator literal-value where:

field-name is a metadata field or bundle.name, bundle.id, bundle.external_id, bundle.created, or bundle.updated.

comparison-operator is ==, <, >, <=, &gt=, or !=

literal-value is a number (integer or decimal), boolean true or false, or a string with either double quotes (") or single quotes (').

Logical operators between terms (and groups of terms) can be && (logical AND), || (logical OR). A logical NOT is ! and can be placed before a term (or group of terms.)


An example filter expression (assuming you have used metadata fields category and tag):


category=="music" && (tag == "soft" || tag == "smooth") && tag != "jazz" && bundle.created > "2014-03-15T00:00:00.0Z"


language parameter specifies the language to use for analyzing the report. This value is only relevant for language-related insight data. Supported languages: en, en-UK, en-US, es, fr.

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.clarify.io//v1/reports/trends?interval='
Response Response Example
200 - Example 1
{}

Request

Query Params
interval
string 
required
Duration of report periods. Default is month.
content
string 
optional
Content reported in each period. Zero or more of tracks, spoken_words, spoken_keywords. List is space or comma separated single string or an array of strings.
filter
string 
optional
filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters.
language
string 
optional
Language to search in, specified with an RFC5646 code. Default is "en"

Responses

🟢200OK
application/json
Body
object {0}
🟠400Bad request
Modified at 2022-09-10 16:56:00
Previous
Generate Group Report <span class="label">beta</span>
Next
Search bundles
Built with