AppSkyline Metadata API

openapi: 3.2.0
info:
  title: Appskyline Com Metadata API
  version: 1.0.0
  x-api-versioning:
    currentVersion: '1'
    requestHeader: API-Version
    responseHeader: API-Version
    compatibilityPolicy: Omitting API-Version selects version 1. Unsupported versions return HTTP 400 with supportedVersions.
    deprecationPolicy: AppSkyline announces incompatible versions at least 180 days before removal. Deprecated responses include Deprecation, Sunset, and a Link relation named deprecation.
    deprecationHeaders:
    - Deprecation
    - Sunset
    - Link
    policyUrl: https://www.appskyline.com/api.md#compatibility-version
  description: 'Operations tagged Metadata across 2 of this provider''s published API definitions: appskyline-api.swagger.json, appskyline-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.appskyline.com
tags:
- name: Metadata
paths:
  /api/metadatasuggestions:
    get:
      operationId: getMetadataSuggestions
      summary: Suggest store metadata from tracked keywords
      description: Audits each store listing against the app's tracked keywords in one market and drafts the indexed fields — the Apple app name, subtitle and 100-character keyword field, the Google Play title (its short description gets the phrases to work in rather than a rewrite), and Microsoft Store search terms. The listing is the synced metadata when the store account is connected, otherwise the live public listing in that market's storefront. Each keyword carries where the listing covers it, its latest stored rank, cached Google web-search demand (a demand proxy, not store popularity) and a priority. Without appId every app of the authenticated organization is analyzed in its main market; listings not reached within the time budget return status deferred. Pass title, subtitle, keywords, shortDescription or description with one appId and store to check proposed text instead. demand=refresh may spend DataForSEO credits on uncached terms; the default only reads the cache. Requires metadata:read, keywords:read and rankings:read for scoped API keys; app-bound keys see only their app. Nothing is written to the stores.
      tags:
      - Metadata
      security:
      - apiKey: []
      - accessToken: []
      parameters:
      - in: query
        name: appId
        schema:
          type: string
      - in: query
        name: store
        schema:
          type: string
          enum:
          - ios-app-store
          - macos-app-store
          - google-play
          - microsoft-store
      - in: query
        name: country
        description: Two-letter market; defaults to the country with most tracked keywords
        schema:
          type: string
      - in: query
        name: language
        description: Listing language; defaults to the market's tracked-keyword language
        schema:
          type: string
      - in: query
        name: demand
        schema:
          type: string
          enum:
          - cached
          - refresh
          default: cached
      - in: query
        name: title
        description: Proposed title to check
        schema:
          type: string
      - in: query
        name: subtitle
        description: Proposed Apple subtitle to check
        schema:
          type: string
      - in: query
        name: keywords
        description: Proposed Apple keyword field or Microsoft search terms to check
        schema:
          type: string
      - in: query
        name: shortDescription
        description: Proposed Google Play short description to check
        schema:
          type: string
      - in: query
        name: description
        description: Proposed full description to check
        schema:
          type: string
      responses:
        '200':
          description: Versioned result with scope, demand, totalApps, truncated, complete and results. Each result has appId, appName, store, storeId, status (ok, no-tracked-keywords, store-not-configured, listing-unavailable or deferred), market and otherMarkets; analyzed results add source, fields, coverage, keywords, issues, suggestions, competitorWords and, when text was proposed, proposal. competitorWords come from competitor titles and are unvetted candidates.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Invalid selector or proposal
        '401':
          description: Authentication required
        '403':
          description: Insufficient scope or app binding
        '404':
          description: No such app in the authenticated organization
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.appskyline.com/api/metadatasuggestions',\n  qs: {\n    appId: 'SOME_STRING_VALUE',\n    store: 'SOME_STRING_VALUE',\n    country: 'SOME_STRING_VALUE',\n    language: 'SOME_STRING_VALUE',\n    demand: 'SOME_STRING_VALUE',\n    title: 'SOME_STRING_VALUE',\n    subtitle: 'SOME_STRING_VALUE',\n    keywords: 'SOME_STRING_VALUE',\n    shortDescription: 'SOME_STRING_VALUE',\n    description: 'SOME_STRING_VALUE'\n  },\n  headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'}\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url 'https://api.appskyline.com/api/metadatasuggestions?appId=SOME_STRING_VALUE&store=SOME_STRING_VALUE&country=SOME_STRING_VALUE&language=SOME_STRING_VALUE&demand=SOME_STRING_VALUE&title=SOME_STRING_VALUE&subtitle=SOME_STRING_VALUE&keywords=SOME_STRING_VALUE&shortDescription=SOME_STRING_VALUE&description=SOME_STRING_VALUE' \\\n  --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
      - lang: Shell + Httpie
        source: "http GET 'https://api.appskyline.com/api/metadatasuggestions?appId=SOME_STRING_VALUE&store=SOME_STRING_VALUE&country=SOME_STRING_VALUE&language=SOME_STRING_VALUE&demand=SOME_STRING_VALUE&title=SOME_STRING_VALUE&subtitle=SOME_STRING_VALUE&keywords=SOME_STRING_VALUE&shortDescription=SOME_STRING_VALUE&description=SOME_STRING_VALUE' \\\n  Authorization:'Basic REPLACE_BASIC_AUTH'"
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.appskyline.com")


          headers = { ''Authorization'': "Basic REPLACE_BASIC_AUTH" }


          conn.request("GET", "/api/metadatasuggestions?appId=SOME_STRING_VALUE&store=SOME_STRING_VALUE&country=SOME_STRING_VALUE&language=SOME_STRING_VALUE&demand=SOME_STRING_VALUE&title=SOME_STRING_VALUE&subtitle=SOME_STRING_VALUE&keywords=SOME_STRING_VALUE&shortDescription=SOME_STRING_VALUE&description=SOME_STRING_VALUE", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/metadatasuggestions?appId=SOME_STRING_VALUE&store=SOME_STRING_VALUE&country=SOME_STRING_VALUE&language=SOME_STRING_VALUE&demand=SOME_STRING_VALUE&title=SOME_STRING_VALUE&subtitle=SOME_STRING_VALUE&keywords=SOME_STRING_VALUE&shortDescription=SOME_STRING_VALUE&description=SOME_STRING_VALUE\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: Basic REPLACE_BASIC_AUTH\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/metadatasuggestions');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n  'appId' => 'SOME_STRING_VALUE',\n  'store' => 'SOME_STRING_VALUE',\n  'country' => 'SOME_STRING_VALUE',\n  'language' => 'SOME_STRING_VALUE',\n  'demand' => 'SOME_STRING_VALUE',\n  'title' => 'SOME_STRING_VALUE',\n  'subtitle' => 'SOME_STRING_VALUE',\n  'keywords' => 'SOME_STRING_VALUE',\n  'shortDescription' => 'SOME_STRING_VALUE',\n  'description' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.appskyline.com/api/metadatasuggestions');\n$request->setRequestMethod('GET');\n$request->setQuery(new http\\QueryString([\n  'appId' => 'SOME_STRING_VALUE',\n  'store' => 'SOME_STRING_VALUE',\n  'country' => 'SOME_STRING_VALUE',\n  'language' => 'SOME_STRING_VALUE',\n  'demand' => 'SOME_STRING_VALUE',\n  'title' => 'SOME_STRING_VALUE',\n  'subtitle' => 'SOME_STRING_VALUE',\n  'keywords' => 'SOME_STRING_VALUE',\n  'shortDescription' => 'SOME_STRING_VALUE',\n  'description' => 'SOME_STRING_VALUE'\n]));\n\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    servers:
    - url: https://api.appskyline.com
components:
  schemas:
    Error:
      type: object
      description: Structured JSON API error.
      required:
      - name
      - message
      - status
      properties:
        name:
          type: string
        message:
          type: string
        status:
          type: integer
        details:
          type: object
          additionalProperties: true
  headers:
    Deprecation:
      description: Present only when this API operation or version is deprecated. The value is an RFC 9745 Structured Field Date.
      schema:
        type: string
        example: '@1893456000'
    DeprecationLink:
      description: Present on deprecated responses and points to the applicable migration or deprecation policy with rel="deprecation".
      schema:
        type: string
        example: <https://www.appskyline.com/api.md#compatibility-version>; rel="deprecation"
    Sunset:
      description: Present on deprecated responses when a retirement date is scheduled. The value is an HTTP-date.
      schema:
        type: string
        example: Tue, 01 Jan 2030 00:00:00 GMT
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: 'HTTP Basic auth carrying only the API key secret: `Authorization: Basic base64(<key secret>)`.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Operator session token issued by the Appskyline dashboard: `Authorization: Token <access token>`.'
x-refined-from:
- appskyline-api.swagger.json
- appskyline-com-openapi.json