| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Account id |
globally unique identifier |
Avaliable on read operations only. |
| ExternalId |
Id for this account in your system (if you keep a list of accounts in your own system) |
string |
Max length: 250 |
| FirstName |
First name |
string |
None. |
| LastName |
Last name |
string |
None. |
|
|
string |
None. |
|
| Password |
Password |
string |
None. |
| Type |
Account type |
string (Enumeration value of AccountType ) |
Possible values: Basic, Premium Required |
| AccountPlanId |
Account plan id |
integer |
Required |
| Status |
Status on specified account |
string (Enumeration value of StatusTP ) |
Avaliable on read operations only. |
| ParentAccountId |
Account id of the parent account (for Reseller API key and for Basic accounts (sub-accounts) only ) |
globally unique identifier |
Required if API key is for Reseller and account type is 'Basic' (it's a sub-account) and you have the ability to create Premium (multi-user) accounts |
| SubAccounts |
List of sub-accounts (available for Premium accounts only) |
Collection of Account |
Avaliable on read operations only. |
| Sites |
List of sites (for Basic accounts (sub-accounts) only) |
Collection of Site |
Avaliable on read operations only. |
| PremiumAccountInfo |
Additional Premium account info (for Premium accounts only) |
PremiumAccountInfo |
Required if account type is 'Premium' |
| IframeStatsToken |
Access token for embeddable Iframe report (the "u" parameter in the Iframe link) |
string |
Avaliable on read operations only. |
| IsLoyaltyProgramAccount |
Is the given account is a loyalty program |
boolean |
Avaliable on read operations only. |