{"$id":"agnostic-query.schema.json","$schema":"http://json-schema.org/draft-07/schema#","type":"object","description":"Agnostic query","required":["dataset"],"definitions":{"filterClauseElement":{"description":"A dataset field or a value","anyOf":[{"type":["boolean","number","string","array","null"]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"","pattern":"^(field)$"},"value":{"type":"string","description":""}}}]},"filterClause":{"type":"object","description":"","required":["left","operator","right"],"properties":{"left":{"$ref":"#/definitions/filterClauseElement","description":"A dataset field or a value"},"operator":{"type":"string","description":"","pattern":"^(=|>|>=|<|<=|!=|IN|NOT IN|LIKE|NOT LIKE)$"},"right":{"oneOf":[{"$ref":"#/definitions/filterClauseElement","description":"A dataset field or a value"},{"$ref":"#/","description":"Another query object"}]}}},"filterGroup":{"type":"object","description":"Group of filter clauses grouped by a logic operator","required":["type","clauses"],"properties":{"type":{"type":"string","description":"","pattern":"^(AND|OR)$"},"clauses":{"type":"array","description":"A list of filter clauses or filter groups","items":{"anyOf":[{"$ref":"#/definitions/filterClause"},{"$ref":"#/definitions/filterGroup"}]}}}}},"properties":{"version":{"type":"integer","description":"Protocol version, defaults to the latest"},"id":{"type":"string","description":"Identifier for the query, if left empty, it will be auto-generated by the server"},"type":{"type":"string","description":"A type string to distinguish from other JSON object types","pattern":"^Drumwave Dataset Query$"},"dataset":{"description":"Universally Unique IDentifier from the dataset to be queried","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"object","required":["id","alias"],"properties":{"id":{"type":"string"},"alias":{"type":"string"},"joinType":{"type":"string","enum":["inner","left","right","subquery"]},"on":{"type":"object","required":["left","right"],"properties":{"left":{"type":"string"},"right":{"type":"string"}}}}}}]},"query":{"type":"object","description":"Query properties","required":[],"properties":{"size":{"type":"integer","description":"Number of expected rows. If this number is bigger than the total amount of rows from the dataset, the total will be returned","default":1000},"distinct":{"type":"boolean","description":"If true then only distinct rows will be returned","default":false},"sorting":{"description":"Sorts the resulting rows either randomly or according to the sorting clauses","anyOf":[{"type":"string","pattern":"^(random)$"},{"type":"array","items":{"type":"object","description":"Sorting clause","required":["field","type"],"properties":{"field":{"type":"string","description":"Name of the output field"},"type":{"type":"string","description":"Determines if the sorting will be ASCending or DESCending","pattern":"^(ASC|DESC)$"}}}}]},"fields":{"type":"array","description":"List of fields or metrics that should be retrieved","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"metric":{"type":"string","enum":["count","sum","average","valueCount","numberOfDifferentValues","sumOfValuesAssociatedToACategoricalValue","meanOfValuesAssociatedToACategoricalValue"]},"fields":{"type":"array"},"values":{"type":"array"}},"required":["metric"]}]}},"filters":{"description":"Filter the dataset using the list of filter clauses","$ref":"#/definitions/filterGroup"},"offset":{"type":"integer","description":"Number of rows to skip before starting to return rows"}}}}}