Apps

List competitors grouped by parent app across all user apps

get/competitors

Request

Base URL: http://localhost:7460/api/v1
URL: http://localhost:7460/api/v1/competitors
Auth: HTTP bearer

Query parameters

platform'ios' | 'android'

searchstring

folder_idstring nullable

Filter by the parent app's folder. Pass an integer for a specific folder, null or unassigned for tracked apps without a folder, or omit to include every parent.

Response

Competitors grouped by parent app

Example response

[
  {
    "parent": {
      "id": 1,
      "external_id": "389801252",
      "display_name": "Instagram",
      "origin_country_code": "us",
      "is_free": true,
      "is_available": true,
      "publisher": {
        "id": 1,
        "name": "Instagram, Inc.",
        "external_id": "389801255",
        "url": "https://apps.apple.com/us/developer/instagram-inc/id389801255"
      },
      "category": {
        "id": 1,
        "name": "Photo & Video",
        "slug": "photo-video"
      },
      "name": "Instagram",
      "rating": 4.68,
      "rating_count": 31,
      "version": "1.2.4"
    },
    "competitors": [
      {
        "id": 1,
        "relationship": "direct",
        "app": {
          "id": 1,
          "external_id": "389801252",
          "display_name": "Instagram",
          "origin_country_code": "us",
          "is_free": true,
          "is_available": true,
          "publisher": {
            "id": 1,
            "name": "Instagram, Inc.",
            "external_id": "389801255",
            "url": "https://apps.apple.com/us/developer/instagram-inc/id389801255"
          },
          "category": {
            "id": 1,
            "name": "Photo & Video",
            "slug": "photo-video"
          },
          "name": "Instagram",
          "rating": 4.68,
          "rating_count": 31,
          "version": "1.2.4"
        }
      }
    ]
  }
]

Changes

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