Get Keywords

Endpoint GET /getKeywords : Retrieve a paginated list of keywords, from Webz.io social media monitoring, assigned to your token.

Query Parameters

token (required) - Authentication token.
page (optional, default: 1) - Page number for results.

Request Example

curl -X 'GET' \
  'https://api.webz.io/socmint/getKeywords?token=YOUR_TOKEN&page=1' \
  -H 'accept: */*'

Behavior & Constraints

Always returns 100 keywords per page.
Only returns keywords assigned to your token.
Results are paginated, with a next link when more pages are available.

Response Example (200):

{
  "keywords": [
    "keyword 1",
    "keyword 2",
    "keyword 3"
  ],
  "page": 1,
  "total_pages": 5,
  "next": "/keywords?token=TOKEN&page=2"
}

Get Keywords by Domain

Endpoint POST /getKeywordsUsingDomains : Retrieve a list of keywords, from Webz.io social media monitoring, assigned to your token and the searched domain or domains.

Example Request

curl -X 'POST' \
  'https://api.webz.io/socmint/getKeywordsUsingDomains' \
  -H 'accept: */*' \
	-H 'Content-Type: application/json' \
  -d '{
  "token": "YOUR_TOKEN",
  "domains": [
    "domain1.com", "domain2.com"
  ]
}'

Behavior & Constraints

Only returns keywords assigned to your token.
Return lists of keywords assigned to each inserted domain.

Response Example (200):

{
  "domainKeywords": {
		"domain1.com": [
    "keyword 1",
    "keyword 2",
    "keyword 3"
  ],
    "domain2.com": [
 		"keyword 1",
    "keyword 2"
  ]
}
  "remainingKeywordsToAdd": 95
}

Add Keywords

Endpoint POST /addKeywords: Add one or more keywords for social media monitoring.

Example Request

curl -X 'POST' \
'https://api.webz.io/socmint/addKeywords' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
   "token": "YOUR_TOKEN",
   "keywordsData": [
    {
      "keywords": [
        "keyword 1"
      ],
      "domains": [
      "domain1.com", "domain2.com"
      ],
      "keywordType": [
        "type"
      ]
    }
  ]
}'

Behavior & Constraints

Accepts multiple keywords per request.
Limit per day: 100 new keywords per day per token.
Limit per token: according to the amount of keywords decided in the contract.
Max keyword length: 500 characters.
Each keyword can be a word or phrase.
Accepts multiple keyword types per request. The accepted types are: search, hashtag, user, group.
If no type was mentioned, the default keyword type is search.
Accepts multiple domains per request.
If no domain was mentioned, the default is insert to all domains.

Response Examples (200)

{
  "status": "added", 
   "keywordsResults": null,
   "remainingKeywordsToAdd": 94
}


{ 
  "status": "all_keywords_already_exists",
    "keywordsResults": null,
    "remainingKeywordsToAdd": 94
}

Error Examples (400)

{
     
  "errorCode": 400,
  "errors": [
    "Invalid domains provided: [wrongdomain.com]"
  ]
}


{
  "errorCode": 400,
  "errors": [
    "Invalid value 'hashtag' for field 'keywordsData.[0].keywordType.[0]'. Accepted values are: [search, tag,    group, user]"
  ]
}


{
  "errorCode": 400,
  "errors": [
    "Keyword must be at most 500 characters"
  ]
}


{
  "errorCode": 400,
  "errors": [
    "must not be empty"
  ]
}


{
  "errorCode": 400,
  "errors": [
    "No template found for keywordType 'tag' with domains [weibo.cn]"
  ]
}

Error Examples (401)

{
  "errorCode": 401,
  "errors": [
    "Missing required role. Access is denied"
  ]
}

Error Examples (404)

{
  "errorCode": 404,
  "errors": [
    "Could not find user for api token 1234"
  ]
}

Error Examples (429)

{
  "errorCode": 429,
  "errors": [
    "Daily keyword limit exceeded. keywords added today: 100"
  ]
}

Delete Keywords

EndpointDELETE /deleteKeywords: Remove one or more keywords from your social media monitoring.

Example Request

curl -X 'DELETE' \
  'https://api.webz.io/socmint/deleteKeywords' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "YOUR_TOKEN",
  "keywordsData": [
    {
      "keywords": [
        "keyword 1"
      ],
      "domains": [
       "domain1.com", "domain2.com"
      ],
      "keywordType": [
        "type"
      ]
    }
  ]
}'

Behavior & Constraints

Accepts multiple keywords per request.
Accepts multiple keyword types per request. The accepted types are: search, hashtag, user, group.
If no keyword type was mentioned, the default is delete from all types.
Accepts multiple domains per request.
If no domain was mentioned, the default is delete from all domains.
The errors are the same as for add-keywords.

Response Example (200)

{
  "status": "deleted",
  "remainingKeywordsToAdd": 89
}