ConstraintsList stored benchmark targets

List stored benchmark targets

The standing targets on file for this location: an account-wide default scope, plus one entry per campaign. These are applied automatically by the analysis endpoint — you never pass them on the request. Every response restates precedence, the order the analysis resolves a step's benchmark in: a benchmark_<step> query param beats a stored campaign target, which beats the stored account default, which beats the account's own pooled rate.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/constraints/benchmarks?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "default": {
      "ad": 0.015
    },
    "default_notes": {},
    "campaigns": [
      {
        "campaign": "example_string",
        "benchmarks": {},
        "notes": {}
      }
    ],
    "updated_at": "2024-12-25T10:00:00Z",
    "precedence": [
      "example_string"
    ],
    "valid_steps": [
      "ad"
    ]
  }
}
GET
/client/v1/constraints/benchmarks
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need constraints:read or constraints:write. See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need constraints:read or constraints:write. See Using an mcp_ key over HTTP.
query
location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need constraints:read or constraints:write. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.

Responses

successboolean
dataobject

The stored benchmark targets for a location, returned by every /benchmarks call.