Skip to content

External Accounts

External accounts link your app store accounts so we can import your sales and other data. Use /external_accounts to list, add, update and delete them.

See the integrations page for every store we support.

Listing Existing Accounts

Section titled “Listing Existing Accounts”

Request

Section titled “Request”
GET /external_accounts

Example Response

Section titled “Example Response”
// GET /external_accounts


{
  "50956": {
    "id": 50956,
    "account_id": 100101,
    "nickname": "Main iTunes",
    "username": "johnny@me.com",
    "auto_import": true,
    "store_id": 1,
    "store": "apple",
    "metadata": {
      "vendor_id": 85261205
    }
  },
  "31174": {
    "id": 31174,
    "account_id": 100101,
    "nickname": "Android apps",
    "username": "coolapps@gmail.com",
    "auto_import": true,
    "store_id": 2,
    "store": "google_play",
    "metadata": {
    }
  },
  ...
}

Looking Up One Account

Section titled “Looking Up One Account”

Request

Section titled “Request”
GET /external_accounts/{external_account_id}

Example Response

Section titled “Example Response”
// GET /external_accounts/31174


{
    "id": 31174,
    "account_id": 100101,
    "nickname": "Android apps",
    "username": "coolapps@gmail.com",
    "auto_import": true,
    "store_id": 2,
    "store": "google_play",
    "metadata": {
    }
}

Creating a New External Account

Section titled “Creating a New External Account”

Request

Section titled “Request”
POST /external_accounts/

Arguments

Section titled “Arguments”

Send arguments as a JSON object in the request body.

Argument Type Description
nickname String A name for this account.
username String The username for the app store account.
password String The password for the app store account.
auto_import Bool (true | false) Whether we import reports for this account automatically.
store String The type of account you’re linking: apple, google_play or amazon.
metadata JSON Extra details for this account. The only supported value is vendor_id, for App Store Connect accounts. Other account types get an empty object.

Example Request

Section titled “Example Request”
// POST /external_accounts/31174


{
  "nickname": "A new account",
  "username": "myusername",
  "password": "p455w0rd!",
  "auto_import": true,
  "store": "apple"
}

Example Response

Section titled “Example Response”
// POST /external_accounts/31174


{
    "id": 31175,
    "account_id": 100101,
    "nickname": "A new account",
    "username": "myusername",
    "auto_import": true,
    "store_id": 1,
    "store": "apple"
}

Updating an External Account

Section titled “Updating an External Account”

Request

Section titled “Request”
PUT /external_accounts/{accountId}

Arguments

Section titled “Arguments”

Send arguments as a JSON object in the request body.

Argument Type Description
nickname String A name for this account.
username String The username for the app store account.
password String The password for the app store account.
auto_import String (true | false) Whether we import reports for this account automatically.

Example Request

Section titled “Example Request”

The account before the update:

// GET /external_accounts/31175


{
    "id": 31175,
    "nickname": "Games Account",
    "username": "awesomegames@me.com",
    "auto_import": true,
    "store": "apple"
}

The update request:

// PUT /external_accounts/31175


{
    "nickname": "A new Nickname(Games Account)",
    "username": "awesomegames+edited@me.com",
    "password": "ipl4yallth3timexx",
    "auto_import": false,
    "store": "apple"
}

Example Response

Section titled “Example Response”
// PUT /external_accounts/31175  with above request body


{
    "id": 31175,
    "nickname": "A new Nickname(Games Account)",
    "username": "awesomegames+edited@me.com",
    "auto_import": false,
    "store": "apple"
}

Deleting an External Account

Section titled “Deleting an External Account”

Request

Section titled “Request”
DELETE /external_account/{id}

Arguments

Section titled “Arguments”
Argument Description
id The ID of the external account to delete.

Example Response

Section titled “Example Response”
// DELETE /external_accounts/90438
// HTTP 204

Note: Deleting an external account won’t remove its products or data.