Output


Endpoint

Field Name

Type

Nullable

Description

get-keywords

keywords

List of strings

No

A list of keywords related to the inserted token (sorted alphabetically).

page

Integer

No

The number of the currently presented page of keywords.

total_pages

Integer

No

The total number of a keywords pages related to the inserted token.

next

String

Yes

URL for the next page (null if none)

get-keywords-using-domains

domainKeywords

Dictionary: key (string)
value (list of strings)

No

A list of keywords related to each inserted domain.

remainingKeywordsToAdd

Integer

No

The number of remaining keywords that can be inserted by this token within these cycle (each cycle is 24 hours).

add-keywords

status

String

No

The status of the request: "added" - if at least one keyword wasn't in our DB for the inserted domains.
"all_keywords_already_exists" - if all keywords were already in our DB for the inserted domains.

keywordsResults

List of dictionaries

Yes

Each dictionary presents the status of a keyword (see the 2 rows below).
Null If the status is similar to all inserted keywords.

keyword

String

No

The relevant keyword.

status

String

No

The only available status is "already_exist", which means the keywords was already in our DB for the inserted domain.

remainingKeywordsToAdd

Integer

No

The number of remaining keywords that can be inserted by this token within these cycle (each cycle is 24 hours).

delete-keywords

status

String

No

Always "deleted".

remainingKeywordsToAdd

Integer

No

The number of remaining keywords that can be inserted by this token within these cycle (each cycle is 24 hours).