ConstraintsClear a scope, or one step of it

Clear a scope, or one step of it

Clears the account default (no campaign) or one campaign's scope. Narrow it to a single step with step=. Never clears more than the one scope named. Requires an agency key (ak_).

curl -X DELETE "https://mythic-analytics.gulp.workers.dev/client/v1/constraints/benchmarks?campaign=example_string&step=ad&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"
    ],
    "cleared": {
      "scope": "example_string",
      "campaign": "example_string",
      "step": "example_string",
      "removed": 42
    }
  }
}
DELETE
/client/v1/constraints/benchmarks
DELETE
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
campaignstring

Campaign scope to clear. Omit to clear the account-wide default — symmetric with PUT.

query
stepstring

Clear only this step. Omit to clear every step in the scope.

Options: ad, tracking, landing, sales, site
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

campaignstring

Campaign scope to clear. Omit to clear the account-wide default — symmetric with PUT.

stepstring

Clear only this step. Omit to clear every step in the scope.

Allowed values:adtrackinglandingsalessite

Responses

successboolean
datastring