{"openapi":"3.0.3","info":{"title":"Steep API","description":"API documentation","version":"1.0.0"},"paths":{"/v1/metrics":{"get":{"description":"Get all metrics for your workspace","tags":["metrics"],"parameters":[{"name":"expand","in":"query","required":false,"schema":{"description":"Whether to resolve and include sub-resources of the metric, like dimensions and slices.","default":"false","format":"boolean","type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"skip":{"type":"number"},"data":{"type":"array","items":{"title":"Metric","allOf":[{"type":"object","properties":{"id":{"description":"Unique resource id, used for referencing the resource.","type":"string"},"identifier":{"description":"Used when defined in YAML.","type":"string"},"label":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"link":{"description":"A link to the metric in the app","type":"string"},"isPrivate":{"type":"boolean"},"teamIdsWithAccess":{"description":"IDs of the teams that have access to the metric. Returns an array of team ids when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"isUnlisted":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"dimensions":{"description":"Dimensions available for this metric. Returns an array of dimensions when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["string-or-boolean","city","country","time","h3-cell-index"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label","type","description"],"additionalProperties":false}},{"type":"null"}]},"module":{"description":"Modules available for this metric. Returns an array of modules when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"title":"Module","type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"identifier":{"type":"string"},"table":{"type":"string"},"schema":{"type":"string"},"externalSource":{"anyOf":[{"type":"string","enum":["dbt-cloud","cube","code"]},{"type":"null"}]}},"required":["id","label","description","identifier","table","schema","externalSource"],"additionalProperties":false},{"type":"null"}]},"slices":{"description":"Slices available for this metric. Returns an array of slices when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"filter":{"anyOf":[{"type":"object","properties":{"column":{"type":"string"},"operator":{"type":"string","enum":["equals","not-equals","less-than","less-than-or-equal","greater-than","greater-than-or-equal","in","not-in","is","is-not","like","not-like"]},"expression":{"type":"string"}},"required":["column","operator","expression"],"additionalProperties":false},{"type":"null"}]}},"required":["id","label","filter"],"additionalProperties":false}},{"type":"null"}]},"cohort":{"description":"Cohort available for this metric. Returns a cohort when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"object","properties":{"deltaTimeCalculationType":{"anyOf":[{"type":"string","const":"calendar-periods"},{"type":"string","const":"rolling-periods"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculateRetention":{"description":"% of initial value.","anyOf":[{"type":"boolean"},{"type":"null"}]},"timeGrains":{"anyOf":[{"type":"array","items":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]}},{"type":"null"}]},"time":{"type":"string"}},"required":["deltaTimeCalculationType","time"],"additionalProperties":false},{"type":"null"}]},"owners":{"description":"Owners of the metric. Returns an array of owner user IDs when `expand=true`, or `null` when `expand=false` (default). These IDs match `/v1/workspace/members[].id`.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"category":{"description":"Category of the metric. Returns a category name when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"string"},{"type":"null"}]},"timeResampling":{"anyOf":[{"type":"string","enum":["sum/divide","average/repeat"]},{"type":"null"}]},"timeGrains":{"anyOf":[{"type":"array","items":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]}},{"type":"null"}]},"filters":{"description":"Filters available for this metric. Returns an array of filters when `expand=true`, or `null` when `expand=false` (default).","anyOf":[{"type":"array","items":{"type":"object","properties":{"column":{"type":"string"},"operator":{"type":"string","enum":["equals","not-equals","less-than","less-than-or-equal","greater-than","greater-than-or-equal","in","not-in","is","is-not","like","not-like"]},"expression":{"type":"string"}},"required":["column","operator","expression"],"additionalProperties":false}},{"type":"null"}]}},"required":["id","identifier","label","description","link","isPrivate","teamIdsWithAccess","isUnlisted","updatedAt","dimensions","module","slices","cohort","owners","category","timeResampling","timeGrains","filters"],"additionalProperties":false},{"oneOf":[{"title":"Metric (sum)","type":"object","properties":{"calculation":{"type":"string","const":"sum"},"value":{"type":"string"}},"required":["calculation","value"],"additionalProperties":false},{"title":"Metric (ratio)","type":"object","properties":{"calculation":{"type":"string","const":"ratio"},"numerator":{"type":"string"},"denominator":{"type":"string"},"format":{"type":"string","enum":["number","percentage"]}},"required":["calculation","numerator","denominator","format"],"additionalProperties":false},{"title":"Metric (count)","type":"object","properties":{"calculation":{"type":"string","const":"count"}},"required":["calculation"],"additionalProperties":false},{"title":"Metric (count distinct)","type":"object","properties":{"calculation":{"type":"string","const":"count-distinct"},"distinct_on":{"type":"string"}},"required":["calculation","distinct_on"],"additionalProperties":false},{"title":"Metric (custom value)","type":"object","properties":{"calculation":{"type":"string","const":"custom-value"},"sqlExpression":{"type":"string"}},"required":["calculation","sqlExpression"],"additionalProperties":false},{"title":"Metric (custom ratio)","type":"object","properties":{"calculation":{"type":"string","const":"custom-ratio"},"numeratorSql":{"type":"string"},"denominatorSql":{"type":"string"},"format":{"type":"string","enum":["number","percentage"]}},"required":["calculation","numeratorSql","denominatorSql","format"],"additionalProperties":false},{"title":"Metric (derived ratio)","type":"object","properties":{"calculation":{"type":"string","const":"derived-ratio"},"numeratorMetricId":{"description":"ID of the metric used as the numerator","type":"string"},"denominatorMetricId":{"description":"ID of the metric used as the denominator","type":"string"},"format":{"type":"string","enum":["number","percentage"]}},"required":["calculation","numeratorMetricId","denominatorMetricId","format"],"additionalProperties":false}]}]}}},"required":["total","limit","skip","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1Metrics"}},"/v1/metrics/{metricId}/query":{"post":{"description":"Query data for a metric","tags":["metrics"],"parameters":[{"name":"metricId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"timeGrain":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]},"fromDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"toDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"breakdownDimensionIds":{"description":"Dimension IDs to breakdown the metric by. Maximum of 2 breakdown dimensions are supported.","maxItems":2,"type":"array","items":{"type":"string"}},"sliceId":{"description":"Slice ID to filter the metric by.","type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"dimensionId":{"title":"Dimension ID","description":"Dimension ID to filter by","type":"string"},"filterValues":{"title":"Filter values","description":"Filter values as strings","type":"array","items":{"type":"string"}}},"required":["dimensionId","filterValues"],"additionalProperties":false}}},"required":["fromDate","toDate"],"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"timeGrain":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]},"fromDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"toDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"breakdownDimensionIds":{"description":"Dimension IDs to breakdown the metric by. Maximum of 2 breakdown dimensions are supported.","maxItems":2,"type":"array","items":{"type":"string"}},"sliceId":{"description":"Slice ID to filter the metric by.","type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"dimensionId":{"title":"Dimension ID","description":"Dimension ID to filter by","type":"string"},"filterValues":{"title":"Filter values","description":"Filter values as strings","type":"array","items":{"type":"string"}}},"required":["dimensionId","filterValues"],"additionalProperties":false}}},"required":["fromDate","toDate"],"additionalProperties":false}},"multipart/form-data":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"timeGrain":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]},"fromDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"toDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"breakdownDimensionIds":{"description":"Dimension IDs to breakdown the metric by. Maximum of 2 breakdown dimensions are supported.","maxItems":2,"type":"array","items":{"type":"string"}},"sliceId":{"description":"Slice ID to filter the metric by.","type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"dimensionId":{"title":"Dimension ID","description":"Dimension ID to filter by","type":"string"},"filterValues":{"title":"Filter values","description":"Filter values as strings","type":"array","items":{"type":"string"}}},"required":["dimensionId","filterValues"],"additionalProperties":false}}},"required":["fromDate","toDate"],"additionalProperties":false}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"cacheTtlInSeconds":{"type":"number"},"refreshedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sql":{"type":"string"},"total":{"type":"number"},"data":{"type":"array","items":{"title":"Data point","type":"object","properties":{"time":{"description":"The time of the data point. Undefined if timeGrain is not provided.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"metric":{"description":"The metric value for the given time.","anyOf":[{"type":"number"},{"type":"null"}]}},"required":["metric"],"additionalProperties":{"title":"Breakdown value","description":"Breakdown value for the given breakdown dimension. The field name matches the breakdown dimension identifier.","anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}}},"required":["cacheTtlInSeconds","refreshedAt","sql","total","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"postV1MetricsByMetricIdQuery"}},"/v1/targets":{"get":{"description":"[Beta] List all target series and their metrics for your workspace","tags":["targets"],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"series":{"type":"string"},"metric_identifier":{"type":"string"},"time_grain":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]},{"type":"null"}]},"from_date":{"type":"string"},"to_date":{"type":"string"},"row_count":{"type":"number"}},"required":["series","metric_identifier","time_grain","from_date","to_date","row_count"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]}}},"dimensions":{"type":"array","items":{"type":"object","properties":{"series":{"type":"string"},"metric_identifier":{"type":"string"},"dimensions":{"type":"array","items":{"type":"string"}}},"required":["series","metric_identifier","dimensions"],"additionalProperties":false}}},"required":["rows","dimensions"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1Targets"}},"/v1/targets/query":{"post":{"description":"[Beta] Query time-series target data for a metric and series","tags":["targets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"metricIdentifier":{"description":"The metric identifier to query targets for. Must match the metric_identifier value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"series":{"description":"The target series to query. Must match the series value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"breakdown":{"description":"Dimension to break down the results by. Each unique value will appear as a separate data point with a `breakdown` field. Must be used together with `filters` that include the breakdown dimension — otherwise per-dimension data will not be returned.","type":"string"},"filters":{"description":"Dimension filters to apply. Keys are dimension names and values are the allowed values — e.g. `{ \"country\": [\"CA\", \"DE\"] }`. When using `breakdown`, you must include the breakdown dimension in `filters` too — otherwise per-dimension data will not be returned.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"required":["metricIdentifier","series"],"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"metricIdentifier":{"description":"The metric identifier to query targets for. Must match the metric_identifier value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"series":{"description":"The target series to query. Must match the series value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"breakdown":{"description":"Dimension to break down the results by. Each unique value will appear as a separate data point with a `breakdown` field. Must be used together with `filters` that include the breakdown dimension — otherwise per-dimension data will not be returned.","type":"string"},"filters":{"description":"Dimension filters to apply. Keys are dimension names and values are the allowed values — e.g. `{ \"country\": [\"CA\", \"DE\"] }`. When using `breakdown`, you must include the breakdown dimension in `filters` too — otherwise per-dimension data will not be returned.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"required":["metricIdentifier","series"],"additionalProperties":false}},"multipart/form-data":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"metricIdentifier":{"description":"The metric identifier to query targets for. Must match the metric_identifier value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"series":{"description":"The target series to query. Must match the series value returned by GET /v1/targets exactly (case-sensitive).","type":"string"},"breakdown":{"description":"Dimension to break down the results by. Each unique value will appear as a separate data point with a `breakdown` field. Must be used together with `filters` that include the breakdown dimension — otherwise per-dimension data will not be returned.","type":"string"},"filters":{"description":"Dimension filters to apply. Keys are dimension names and values are the allowed values — e.g. `{ \"country\": [\"CA\", \"DE\"] }`. When using `breakdown`, you must include the breakdown dimension in `filters` too — otherwise per-dimension data will not be returned.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"required":["metricIdentifier","series"],"additionalProperties":false}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"value":{"type":"number"}},"required":["time","value"],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}},"timeGrain":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"]},{"type":"null"}]},"cacheTtlInSeconds":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["data","timeGrain","cacheTtlInSeconds"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"postV1TargetsQuery"}},"/v1/entities":{"get":{"description":"Get all entities for your workspace","tags":["entities"],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"skip":{"type":"number"},"data":{"type":"array","items":{"title":"Entity","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"moduleId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","moduleId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["total","limit","skip","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1Entities"}},"/v1/modules":{"get":{"description":"Get all modules for your workspace","tags":["modules"],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"skip":{"type":"number"},"data":{"type":"array","items":{"title":"Module","type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"identifier":{"type":"string"},"table":{"type":"string"},"schema":{"type":"string"},"externalSource":{"anyOf":[{"type":"string","enum":["dbt-cloud","cube","code"]},{"type":"null"}]}},"required":["id","label","description","identifier","table","schema","externalSource"],"additionalProperties":false}}},"required":["total","limit","skip","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1Modules"}},"/v1/workspace/members":{"get":{"description":"Get all members for your workspace","tags":["workspace"],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"skip":{"type":"number"},"data":{"type":"array","items":{"title":"Member","type":"object","properties":{"id":{"description":"User ID for this member. This matches IDs returned in `metrics.owners`.","type":"string"},"workspaceMemberId":{"description":"Workspace member record ID.","type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string"},"loginMethod":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","workspaceMemberId","name","email","image","role","loginMethod","createdAt","updatedAt"],"additionalProperties":false}}},"required":["total","limit","skip","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1WorkspaceMembers"}},"/v1/workspace/teams":{"get":{"description":"Get all teams for your workspace","tags":["workspace"],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"skip":{"type":"number"},"data":{"type":"array","items":{"title":"Team","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"type":"string"},"isPrivate":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"description":"User ID for this member. This matches IDs returned in `metrics.owners`.","type":"string"},"workspaceMemberId":{"description":"Workspace member record ID.","type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"loginMethod":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","workspaceMemberId","name","email","image","loginMethod","createdAt","updatedAt"],"additionalProperties":false}}},"required":["id","name","description","color","isPrivate","createdAt","updatedAt","members"],"additionalProperties":false}}},"required":["total","limit","skip","data"],"additionalProperties":false}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","validationErrors"],"additionalProperties":false}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"operationId":"getV1WorkspaceTeams"}}},"components":{"schemas":{}}}