API reference / Keywords

Track a keyword

POST/api/v1/keywords

Authorization

Send your API key or MCP OAuth token in the Authorization: Bearer header. Active or trialing Unlimited is required.

Required permission content:write

Every mutation requires JSON and an Idempotency-Key. Reuse the same key and exact input when retrying.

Parameters

Idempotency-Keyheaderrequired

string

Persist this key for retries. Reusing it with changed input returns 409. Receipts are retained for at least 24 hours.

min length: 8 · max length: 128

Request body

application/json

projectIdbodyrequired

string · uuid

appIdbodyoptional

string | null

keywordsbodyrequired

string[]

min items: 1 · max items: 50

countrybodyoptional

string

langbodyoptional

string

min length: 2 · max length: 16

countriesbodyoptional

object[]

min items: 1 · max items: 50

sourcebodyoptional

"type" | "suggest" | "competitor" | "auto_detect"

default: "type"

storeProviderbodyoptional

"app_store" | "google_play"

default: "app_store"

View complete request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "appId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ]
    },
    "keywords": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    },
    "lang": {
      "type": "string",
      "minLength": 2,
      "maxLength": 16,
      "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
    },
    "countries": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "pattern": "^[A-Za-z]{2}$"
          },
          "lang": {
            "type": "string",
            "minLength": 2,
            "maxLength": 16,
            "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
          }
        },
        "required": [
          "country",
          "lang"
        ],
        "additionalProperties": false
      }
    },
    "source": {
      "default": "type",
      "type": "string",
      "enum": [
        "type",
        "suggest",
        "competitor",
        "auto_detect"
      ]
    },
    "storeProvider": {
      "default": "app_store",
      "type": "string",
      "enum": [
        "app_store",
        "google_play"
      ]
    }
  },
  "required": [
    "projectId",
    "keywords"
  ],
  "additionalProperties": false
}

Request example

Set ALF_API_URL to https://dashboard.applaunchflow.com/api/v1 and ALF_API_KEY to your key. Replace sample IDs with your project’s values. Use a new ALF_REQUEST_ID for each new operation.

cURL

curl --request POST \
  --url "$ALF_API_URL/keywords" \
  --header "Authorization: Bearer $ALF_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $ALF_REQUEST_ID" \
  --data '{
  "projectId": "11111111-1111-4111-8111-111111111111",
  "keywords": [
    "string"
  ]
}'

This example shows the request structure. Some editor operations require additional query parameters that are not yet described in OpenAPI.

Response

Successful JSON responses wrap the result in data, with a request ID in meta.requestId.

okdatarequired

boolean

addeddatarequired

integer

minimum: -9007199254740991 · maximum: 9007199254740991

staleCountdatarequired

integer

minimum: -9007199254740991 · maximum: 9007199254740991

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "ok": {
          "type": "boolean"
        },
        "added": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "staleCount": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "ok",
        "added",
        "staleCount"
      ]
    },
    "meta": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Errors & retries

Errors use application/problem+json. Check the stable code and keep requestId when contacting support. Respect Retry-After on 429 responses.

See error handling and idempotency →