action clarify_v1reportsscores { label: "Generate Group Report beta" description: "Analyzes bundle content over a series of time periods grouped by the value of group_field metadata field and generates a report of top scores.

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.

score_field specifies a bundle, insights, or metadata field to use as a score. The scores will be averaged across the group and listed in descending order.

group_field specifies a metadata field by which to group statistics. Typically the field will represent a user or team id to get a report of the scores for the top users or teams.

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 ==, <, >, <=, >=, 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." provider: clarify method: GET path: "/v1/reports/scores" encoding: json input: { type: "object" properties: { filter: { type: "string" } group_field: { type: "string" } interval: { type: "string" } language: { type: "string" } score_field: { type: "string" } } required: ["group_field", "interval", "score_field"] additionalProperties: false } output: { type: "object" additionalProperties: true } }