Supported Formats

json

GET /api/domains
Lists domains.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
mode
optional

Domains listing mode

Validations:

  • Must be a String

account_id
optional

Domains listing for given account

Validations:

  • Must be a String

count
optional

items count in payload

Validations:

  • Must be a Integer

offset
optional

items start position

Validations:

  • Must be a Integer

order_by
optional

items sort field

Validations:

  • Must be a String

order_asc
optional

items sort order

Validations:

  • Must be a String

search
optional

Validations:

  • Must be a Hash


GET /api/domains/:id
Shows project domain.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
optional

Domain ID

Validations:

  • Must be a String


PUT /api/domains/:id
Update domain

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Domain Not Found

Params

Param name Description
id
required

Domain ID

Validations:

  • Must be a String


POST /api/domains
Creates new domain.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Domain Not Found.
422 Unprocessable Domain.

Params

Param name Description
account_id
required

Business Account Id

Validations:

  • Must be a String


DELETE /api/domains/:id
Delete domain

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Domain Not Found
422 Unprocessable Domain.

Params

Param name Description
id
required

Domain ID

Validations:

  • Must be a String


POST /api/domains/upload_from_tsv
Uploads domain from TSV file.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Domain Not Found.
422 Unprocessable Domain.

Params

Param name Description
account_id
required

Business Account Id

Validations:

  • Must be a String


GET /api/domains/assumptions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
term
required

keyword to be searched

Validations:

  • Must be a String

mode
optional

mode to retrieve templates from: account or library

Validations:

  • Must be a String

account_id
optional

Domains listing for given account

Validations:

  • Must be a String


GET /api/domains/parse_meta

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
url
required

Url for meta

Validations:

  • Must be a String


POST /api/domains/invite_account
Invite member for share domain

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain ID

Validations:

  • Must be a String

emails_or_ids
required

User email to send invitation

Validations:

  • Must be an array of any type


GET /api/domains/shared_accounts
List accounts of domain

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain ID

Validations:

  • Must be a String

account_id
required

Account ID

Validations:

  • Must be a String


DELETE /api/domains/delete_shared_account
Remove shared account

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_id
required

Account ID

Validations:

  • Must be a String

domain_id
required

Domain ID

Validations:

  • Must be a String


GET /api/domains/analytics

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
url
required

Url for analysis

Validations:

  • Must be a String

token
optional

Wordpress slimstat plugin token for url

Validations:

  • Must be a String

revenue_per_visit
optional

Value for calculating revenue

Validations:

  • Must be a String


GET /api/domains/projects
Projects where the given domain is used

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Domain Not Found
422 Unprocessable Domain.

Params

Param name Description
domain_id
required

Domain Id

Validations:

  • Must be a String


POST /api/domains/multiple_domain_action
Performs an action on multiple domains.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unknown action.

Params

Param name Description
batch_action
required

Action to be applied to domains

Validations:

  • Must be a String

domain_ids
required

Array of domain ids

Validations:

  • Must be an array of any type

shared_account_email
optional

Array of shared account emails

Validations:

  • Must be an array of any type

select_all
optional

If true select all domains

Validations:

  • Must be a Boolean


GET /api/domains/domain_count

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
account_id
required

Domains count for given account

Validations:

  • Must be a String

mode
optional

Domains listing mode

Validations:

  • Must be a String


GET /api/domains/whois

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
url
required

Url for whois data

Validations:

  • Must be a String


GET /api/domains/serpbook

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
url
required

Url for serpbook data

Validations:

  • Must be a String


GET /api/domains/regions_and_languages

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

POST /api/domains/serpbook_actions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Domain ID

Validations:

  • Must be a String

keyword
required

Keywords for serpbook analytics

Validations:

  • Must be an array of any type

region
required

Google region for serpbook analytics

Validations:

  • Must be a String

language
required

Language for serpbook analytics

Validations:

  • Must be a String

tracking
required

Which platform for serpbook, should be desktop or mobile

Validations:

  • Must be a String

location
optional

Location for serpbook

Validations:

  • Must be a String

serpbook_action
required

Performs an action on serpbook.

Validations:

  • Must be a String


GET /api/domains/suggestion_keywords

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain ID

Validations:

  • Must be a String


POST /api/domains/change_owner
Change domain owners

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
mode
optional

When mode is share, moved domain(s) would be shared with previous owner

Validations:

  • Must be a String

domain_ids
required

Domain Ids

Validations:

  • Must be an array of any type

email
required

Email of the owner of the account, where domains are to be moved

Validations:

  • Must be a String


GET /api/domains/serpbook_tmp_to_real

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Domain ID

Validations:

  • Must be a String


POST /api/domains/save_scripts

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain Id

Validations:

  • Must be a String

scripts
required

Scripts content in JSON format

Validations:

  • Must be a Hash


GET /api/domains/scripts

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain Id

Validations:

  • Must be a String


GET /api/domains/plugin_list

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain Id

Validations:

  • Must be a String


POST /api/domains/plugin_remote_actions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
domain_id
required

Domain Id

Validations:

  • Must be a String

plugin_action
required

Action

Validations:

  • Must be a String

plugin_name
required

Plugin name

Validations:

  • Must be a String