Description
Input POST body should either be application/x-www-form-urlencoded or raw JSON.
Takes either url or text as input, not both at the same time. That means there is a difference between analyzing an url or a plain text.
Available fields in POST body
PARAMETER |
DESCRIPTION |
|
url
|
url Full URL of the article to be analyzed. (e.g. http://domain.com/folder/article001.html) |
|
text | Raw text to be analyzed.
Note: You can use the parameter "url" OR "text". A combination of both leads to an error. |
|
numberOfKeywords |
Number of keywords returned in JSON response. (default number = 5). We recommend a setting of 2 up to 3 keywords, if you want to use the API for use cases like “contextual video” or “contextual advertising”. |
|
uuid |
Type = String Can be used for tracking purposes. If you want to personalize your offer for a specific user or enrich a user's data set you can inject here an identifier. |
|
customData |
Type = String (array) Can contain any custom information, identifier, etc. |
|
|
||
getText |
Type = Boolean (Default=False) Switch specifying (getText=True) if the system should return the extracted text. |
|
getMeta |
Type = Boolean (Default=False) Switch specifying (getMeta=True) if the system should return the extracted meta keywords. |
|
imagedivid |
Type = String Instead of letting the system automatically choose the appropriate image, you can enter the id of the image div that should be used. With the parameter "imagedivid" you can force our API to extract the image URL of a specific image Advice: API v2 only! |
|
articledivid |
Type = String. The parameter arcticledivid allows you to specify which part of the website should be used for the text analysis/keyword extraction. {\"parameter\":\"value\"} Advice: The string parameter and/or value has to be escaped exactly once! String example:
Parameter value example:
Advice: API v2 only! |
|
Comments
0 comments
Article is closed for comments.