The current batch of sample creators (sample review stores)

GET

/locations/{partner_location_id}/creator-samples

const url = 'https://data.creatorain.com/partner/v1/locations/store_123/creator-samples';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://data.creatorain.com/partner/v1/locations/store_123/creator-samples \
  --header 'Authorization: Bearer <token>'

For a store with approval_mode: sample_review: 5 sample creators that show the range of creators the store will get, and a summary (follower range, common topics, audience). Samples are not the final list. We send location.samples_ready when a batch is ready.

status is preparing (a batch is being prepared, creators is empty), ready (waiting for your decision) or approved (recruiting follows; location.recruiting when it starts).

Public profile only: no email, phone, name or rates.

EITHER CREDENTIAL: the partner key or that store’s own token.

Authorizations

Parameters

Path Parameters

partner_location_id

required

string

<= 200 characters

YOUR id for the store, as you sent it to POST /locations.

Example

store_123

Responses

200

The current batch.

application/json

object

batch_id

required

string

nullable

batch_number

required

integer

nullable

status

required

string

Allowed values: preparing ready approved

prepared_at

string format: date-time

nullable

decided_at

string format: date-time

nullable

summary

object

followers_min

integer

nullable

followers_max

integer

nullable

followers_average

integer

nullable

common_topics

Array<string>

audience

string

nullable

creators

required

Array<object>

One sample creator. Public profile only.

object

handle

string

nullable

platforms

Array<string>

followers

integer

nullable

city

string

nullable

average_views

integer

nullable

topics

Array<string>

recent_posts

Array<object>

object

post_url

string

views

integer

nullable

Example

{
  "batch_id": "smp_1b4e28ba-2fa1-4d3b-a3f5-ef19b5a7633b",
  "batch_number": 1,
  "status": "preparing",
  "summary": {
    "followers_min": 7900,
    "followers_max": 24800,
    "followers_average": 14380,
    "common_topics": [
      "food",
      "travel"
    ],
    "audience": "local (San Jose)"
  },
  "creators": [
    {
      "handle": "example_creator_2",
      "platforms": [
        "instagram",
        "tiktok"
      ],
      "followers": 18200,
      "city": "San Jose",
      "average_views": 12400,
      "topics": [
        "food"
      ],
      "recent_posts": [
        {
          "post_url": "https://www.instagram.com/p/...",
          "views": 12000
        }
      ]
    }
  ]
}

401

unauthorized. A missing, malformed, unknown or revoked key; or an invalid, expired or wrong-store dashboard token. One answer for every case on purpose: the holder of a bad credential learns nothing from the difference.

application/json

object

error

required

object

code

required

The stable value to branch on.

string

Allowed values: unauthorized forbidden_ip rate_limited validation_error location_already_exists location_not_found location_terminated reservation_not_found conflict internal_error

message

required

A human sentence. Copy, not contract; it may be reworded.

string

field

The request field at fault, dotted for a nested one (plan.term_months).

string

Example

{
  "error": {
    "code": "unauthorized"
  }
}

404

location_not_found. No store of this key carries that partner_location_id.

application/json

object

error

required

object

code

required

The stable value to branch on.

string

Allowed values: unauthorized forbidden_ip rate_limited validation_error location_already_exists location_not_found location_terminated reservation_not_found conflict internal_error

message

required

A human sentence. Copy, not contract; it may be reworded.

string

field

The request field at fault, dotted for a nested one (plan.term_months).

string

Example

{
  "error": {
    "code": "unauthorized"
  }
}

409

conflict. The store does not use sample review.

application/json

object

error

required

object

code

required

The stable value to branch on.

string

Allowed values: unauthorized forbidden_ip rate_limited validation_error location_already_exists location_not_found location_terminated reservation_not_found conflict internal_error

message

required

A human sentence. Copy, not contract; it may be reworded.

string

field

The request field at fault, dotted for a nested one (plan.term_months).

string

Example

{
  "error": {
    "code": "unauthorized"
  }
}

429

rate_limited. Over this key’s requests-per-minute ceiling.

application/json

object

error

required

object

code

required

The stable value to branch on.

string

Allowed values: unauthorized forbidden_ip rate_limited validation_error location_already_exists location_not_found location_terminated reservation_not_found conflict internal_error

message

required

A human sentence. Copy, not contract; it may be reworded.

string

field

The request field at fault, dotted for a nested one (plan.term_months).

string

Example

{
  "error": {
    "code": "unauthorized"
  }
}