Sign in
Targets & Blacklist

Set the shop's performance targets

Set or update the goal values the shop is measured against for one granularity — the numbers behind the dashboard's progress bars.

Upsert semantics: if the shop already has targets for the given granularity, the most recent set is updated in place; otherwise a new set is created. Only the metrics you send are stored, so send the full set you want in effect rather than a partial diff.

Available metrics: target_collabs, creators_messaged, sample_requests, sample_approved, videos_posted, videos_converted, spark_codes. At least one is required, and each must be a non-negative integer.

Read the current targets back with GET /targets. Requires a key with read_write scope and a single shop.

put/targets

Request body

granularity'weekly' | 'monthly' | 'quarterly' required

Supported target granularity options

effective_fromstring date-time nullable

When the goals start applying. Defaults to now. Cannot be more than a year in the future.

Example request

{
  "granularity": "monthly",
  "targets": {
    "creators_messaged": 200,
    "target_collabs": 50,
    "videos_posted": 35
  }
}

Response

Successful Response

createdboolean required

True when no target existed for this granularity and a new one was created; false when an existing one was updated.

Example response

{
  "target": {
    "created_at": "2024-01-01T00:00:00Z",
    "customer_id": 924,
    "granularity": "monthly",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "shop_id": 1183,
    "targets": {
      "creators_messaged": 200,
      "sample_approved": 80,
      "sample_requests": 100,
      "spark_codes": 10,
      "target_collabs": 50,
      "videos_converted": 25,
      "videos_posted": 35
    },
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.