# Check which store searches find the app now

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [POST /api/v1/external/coding/customers/{customer\_id}/repositories/{repository\_id}/store/searches](#scalar-operation-post-apiv1externalcodingcustomerscustomer-idrepositoriesrepository-idstoresearches)

**Schemas**

- [StoreSearchRunRead](#scalar-schema-storesearchrunread)
- [StoreSearchCheck](#scalar-schema-storesearchcheck)
- [StoreSearchPlatforms](#scalar-schema-storesearchplatforms)
- [StoreSearchStore](#scalar-schema-storesearchstore)
- [StoreSearchRow](#scalar-schema-storesearchrow)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### Store

Beta: may change without notice. Shipping an app to the App Store and Google Play: store connections, builds, releases and rollouts, the store listing in every language, screenshots, review logins and the release checklist.

## Operations

<a id="scalar-operation-post-apiv1externalcodingcustomerscustomer-idrepositoriesrepository-idstoresearches"></a>

### Check which store searches find the app now

- **Method:** `POST`
- **Path:** `/api/v1/external/coding/customers/{customer_id}/repositories/{repository_id}/store/searches`
- **Operation ID:** `checkStoreSearches`
- **Tags:** Store

Runs one check now (a few seconds) on every enabled store with an id (the App Store app, the Google Play package) and answers it as `latest`. Charged to the workspace at the vendor's cost plus the usage markup, never above the quote's `max_usd`. 400 when no enabled store has the app, 402 without enough credits, 429 `check_limit` after 3 checks for the app in a UTC day, 502 when no store answered. Signed-in owners and admins only.

**Servers:** [Inherited servers](#scalar-context-global-servers)

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Path parameters

- **`customer_id` (required)**: `string`, format: `uuid`
- **`repository_id` (required)**: `string`, format: `uuid`

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[StoreSearchRunRead](#scalar-schema-storesearchrunread)

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "latest": {
    "charged_usd": 1,
    "checked_at": "",
    "id": "",
    "platforms": {
      "android": {
        "rows": [
          {
            "difficulty": 1,
            "keyword": "",
            "rank": 1,
            "searches": 1
          }
        ],
        "total": 1
      },
      "ios": {
        "rows": [
          {
            "difficulty": 1,
            "keyword": "",
            "rank": 1,
            "searches": 1
          }
        ],
        "total": 1
      }
    }
  }
}
```

##### 400, 401, 403, 404

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access
- `404` Resource not found

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-2)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-3"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-storesearchrunread"></a>

### StoreSearchRunRead

**Type:** `object`

- **`latest` (required)**: [StoreSearchCheck](#scalar-schema-storesearchcheck)

<a id="scalar-example-4"></a>

**Generated example:**

```json
{
  "latest": {
    "charged_usd": 1,
    "checked_at": "",
    "id": "",
    "platforms": {
      "android": {
        "rows": [
          {
            "difficulty": 1,
            "keyword": "",
            "rank": 1,
            "searches": 1
          }
        ],
        "total": 1
      },
      "ios": {
        "rows": [
          {
            "difficulty": 1,
            "keyword": "",
            "rank": 1,
            "searches": 1
          }
        ],
        "total": 1
      }
    }
  }
}
```

<a id="scalar-schema-storesearchcheck"></a>

### StoreSearchCheck

**Type:** `object`

- **`charged_usd` (required)**: `number`
- **`checked_at` (required)**: `string`, format: `date-time`
- **`id` (required)**: `string`
- **`platforms` (required)**: [StoreSearchPlatforms](#scalar-schema-storesearchplatforms)

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "charged_usd": 1,
  "checked_at": "",
  "id": "",
  "platforms": {
    "android": {
      "rows": [
        {
          "difficulty": 1,
          "keyword": "",
          "rank": 1,
          "searches": 1
        }
      ],
      "total": 1
    },
    "ios": {
      "rows": [
        {
          "difficulty": 1,
          "keyword": "",
          "rank": 1,
          "searches": 1
        }
      ],
      "total": 1
    }
  }
}
```

<a id="scalar-schema-storesearchplatforms"></a>

### StoreSearchPlatforms

**Type:** `object`

- **`android`**: [StoreSearchStore](#scalar-schema-storesearchstore) | `null`
- **`ios`**: [StoreSearchStore](#scalar-schema-storesearchstore) | `null`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "android": {
    "rows": [
      {
        "difficulty": 1,
        "keyword": "",
        "rank": 1,
        "searches": 1
      }
    ],
    "total": 1
  },
  "ios": {
    "rows": [
      {
        "difficulty": 1,
        "keyword": "",
        "rank": 1,
        "searches": 1
      }
    ],
    "total": 1
  }
}
```

<a id="scalar-schema-storesearchstore"></a>

### StoreSearchStore

**Type:** `object`

- **`rows` (required)**: array of [StoreSearchRow](#scalar-schema-storesearchrow)
- **`total` (required)**: `integer`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "rows": [
    {
      "difficulty": 1,
      "keyword": "",
      "rank": 1,
      "searches": 1
    }
  ],
  "total": 1
}
```

<a id="scalar-schema-storesearchrow"></a>

### StoreSearchRow

**Type:** `object`

- **`keyword` (required)**: `string`
- **`rank` (required)**: `integer`
- **`difficulty`**: `integer | null`
- **`searches`**: `integer | null`

<a id="scalar-example-8"></a>

**Generated example:**

```json
{
  "difficulty": 1,
  "keyword": "",
  "rank": 1,
  "searches": 1
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-9"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.