Sign in
Apps

Add a competitor to an app

post/apps/{platform}/{externalId}/competitors

Request

  • Base URL: http://localhost:7460/api/v1
  • URL: http://localhost:7460/api/v1/apps/{platform}/{externalId}/competitors
  • Auth: HTTP bearer

Path parameters

platform'ios' | 'android' required
externalIdstring required

Request body

competitor_external_idstring

Store identifier of the competitor app. Auto-registers the app row if missing.

competitor_platform'ios' | 'android'

Platform of the competitor. Defaults to the parent app's platform when omitted.

competitor_app_idinteger

Legacy: internal numeric apps.id of the competitor. Use competitor_external_id instead when calling the API directly.

relationship'direct' | 'indirect' | 'aspiration'

Example request

{
  "competitor_external_id": "com.aadhk.woinvoice",
  "competitor_platform": "android",
  "competitor_app_id": 2,
  "relationship": "direct"
}

Response

Competitor added

idinteger required
app_idinteger required
competitor_app_idinteger required
relationship'direct' | 'indirect' | 'aspiration' required
created_atstring date-time
updated_atstring date-time

Example response

{
  "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

Changes to this operation have not been checked yet.