Introduction
Neticle’s Data API is a standard REST API for retrieving all the data that is available in our system.
It makes possible the integration of our analyzed textual and aggregated data to any third-party systems directly or via connectors.
The most frequent (but not only) use cases:- Channeling Neticle’s enhanced textual data (mentions) within your own BI system
- Getting aggregations / KPIs for your own dashboards
- Retrieving identified insights about keywords
- Retrieving chart data as JSON for chart visualization purposes- under development
Authorization
We standardized all different ways of authentication in this new iteration of the Data API, including (but not limited to) the ApiKey-based authentication method as well. We've made sure that your existing ApiKey is still valid, the way you provide it to the API, however, has changed.
Going forward, no matter the form of credentials you posess, they all will be communicated through the Authorization header. You can use the [basic auth standard] to specify your ApiKey, which defines it's basic shape as follows:
Authorization: Basic <credentials>
To generate the value for the header, you can take the following steps:
-
Take your existing ApiKey or request a new one:
You can edit the example ApiKey above to your actual one to have the values generated for you.
-
Append a : (colon) character at the end:
ExampleApiKey__lnREQII6yJjMZb4K4:
-
Take the string you created in step 2, apply a Base64 encoding over it:
You should use a standard Base 64 encoder (for example .btoa() in JS), and not it's url-compatible variant!RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6
-
Take the result string from step 3 and prepend the string "Basic " at the start:
Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6
-
You can use the string from step 4 as the value of the Authorization header:
Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6
For the rest of this documentation, the lock icon () will indicate endpoints which are protected, and where you must provide an Authorization header in order to be able to successfully receive a response from them.
Endpoints with icon can be used without any Authorization header.
Rate limiting
All of our endpoints are limited for querying in a given timeframe. We differentiate our rate limiting policy based on the authorization of the endpoints:
-
ApiKey protected endpoints
No more than 5000 requests can be processed in each 1 hour timeframe with the same ApiKey. (This means no more than 83 requests / min or 1,3 requests / sec in average for 1 hour.)
-
Endpoints without ApiKey authorization
No more than 60 requests can be processed in each 1 minute timeframe from the same IP address.
In each API response’s response header we embed the current quota usage information:
RateLimit-Limit: <number> --max allowed queries in the timeframe
RateLimit-Remaining: <number> --how many queries can be made for the same endpoint and for all other endpoints with the same authorization method
RateLimit-Reset: <number> --seconds left until the end of the current timeframe so when the quota usage resets
RateLimit-ResetAt: <number> --timestamp when the timeframe ends
In particular we suggest not to perform more than 1 query in each sec to our API so no rate limitation error will be responded.
Versioning
Versions | Status | Released | End-of-life |
---|---|---|---|
23.10 | Release candidate | ||
22.09 | Latest | 2022.09.15. | ~ 2023.09.15 |
v2.7 | Flagged for depreciation | 2023.03.15. | |
v2.6 | Flagged for depreciation | 2023.03.15 | |
v2.5 | Flagged for depreciation | 2023.03.15. | |
v2.4 | Flagged for depreciation | 2023.03.15. | |
v2.3 | Flagged for depreciation | 2023.03.15. |
When a new API version is released, the older ones are starting their 6 month depreciation period.
We plan new versions twice a year, approximately 6 month apart. The different versions may not be backwards compatible but not necessarily.
Versioning scheme
From 22.09 we no longer use the SemVer but the CalVer versioning scheme.
The minor changes will not increase the API version and should be backwards compatible so no URL modification needed from the client side.
Because of this approach the response structure JSONs are never missing a previously existing key, but the JSONs can be extended with new keys within the same version.
Also new endpoints may be added without increasing the version.
Clients
Provides an interface to interact with the client objects stored in our databases.
Listing clients
GET /clients
curl -G https://data.neticle.com/22.09/clients \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/clients', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/clients") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/clients" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/clients', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Finding a single client
GET /clients/:clientId
curl -G https://data.neticle.com/22.09/clients/:clientId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/clients/:clientId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/clients/:clientId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/clients/:clientId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/clients/:clientId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Client |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Aspects
Provides an interface to interact with the aspect objects stored in our databases.
Listing aspects
GET /aspects
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. | |
keywordGroupId omittable |
number |
Filter by a keyword group. | |
aspectGroupId omittable |
number |
Filter by an aspect group. | |
keywordId omittable |
number |
Filter by a keyword. |
{
"clientId": 0,
"profileId": 0,
"keywordGroupId": 0,
"aspectGroupId": 0,
"keywordId": 0
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/aspects?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0
curl -G https://data.neticle.com/22.09/aspects \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'\ -d 'keywordGroupId=0'\ -d 'aspectGroupId=0'\ -d 'keywordId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/aspects?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/aspects?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/aspects?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/aspects?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Finding a single aspect
GET /aspects/:aspectId
curl -G https://data.neticle.com/22.09/aspects/:aspectId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/aspects/:aspectId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/aspects/:aspectId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/aspects/:aspectId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/aspects/:aspectId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Aspect |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Sources
Provides an interface to interact with the content sources stored in our databases.
Listing content sources
GET /sources
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
SourceConstraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
countryId omittable |
number |
The id of the country to query sources for. | |
keywordId omittable |
number |
The id of the keyword to query sources for. | |
aspectId omittable |
string |
The id of the aspect to query sources for. |
{
"countryId": 0,
"keywordId": 0,
"aspectId": 0
}
First, format the structure to an URL-encoded string:
countryId=0&keywordId=0&aspectId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/sources?countryId=0&keywordId=0&aspectId=0
curl -G https://data.neticle.com/22.09/sources \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'countryId=0'\ -d 'keywordId=0'\ -d 'aspectId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/sources?countryId=0&keywordId=0&aspectId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/sources?countryId=0&keywordId=0&aspectId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/sources?countryId=0&keywordId=0&aspectId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/sources?countryId=0&keywordId=0&aspectId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Source[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Source[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Source[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Mentions
Provides an interface to interact with the mention objects stored in our databases.
Listing mentions
GET /mentions
This is an endpoint that will return mentions for every keyword and/or aspect you specify in the filter structure.
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
View
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
filters required |
ViewFilter |
A structure that influences the multiplicity of the results. | |
presentation omittable |
Presentation |
A structure that influences how your data will be presented.
Default:
|
{
"filters": {
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
}
Referenced entities by View
Property | Type | Comment | |
---|---|---|---|
aspects required |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords required |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval omittable |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources omittable |
SourceGroup[] |
Filters between the content sources.
Default:
|
|
genders omittable |
GenderGroup[] |
Filters for the gender of the author.
Default:
|
|
polarities omittable |
PolarityGroup[] |
Filters for sentiment between the results.
Default:
|
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end required |
number |
The latest time in milliseconds. | |
start required |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
currentPage omittable |
number |
Controls from which page the result set will be returned
Default:
|
|
numberOfValues omittable |
number |
The number of mentions per page
Default:
|
|
orderBy omittable |
OrderBy[] |
Controls the order of the result set
Default:
|
|
includeResourceMap omittable |
boolean |
Toggles whether the response should include a lookup map for all the resource IDs as a meta object.
Default:
|
|
ianaTimeZone omittable |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. |
{
"currentPage": 1,
"numberOfValues": 100,
"orderBy": [
{
"by": 1,
"direction": "asc"
}
],
"includeResourceMap": false,
"ianaTimeZone": "Europe/Budapest"
}
Referenced entities by Presentation
Property | Type | Comment | |
---|---|---|---|
id required |
NumericProperty |
The identifier of the property to order by | |
order required |
OrderDirection |
The direction of the order |
{
"id": 1,
"order": "desc"
}
Referenced entities by OrderBy
Value | Comment | ||
---|---|---|---|
1 |
Creation time | ||
2 |
Polarity index | ||
3 |
Content length | ||
4 |
Importance | ||
6 |
Reach | ||
7 |
Count of interactions | ||
8 |
Count of likes | ||
9 |
Count of dislikes | ||
10 |
Count of reactions | ||
11 |
Count of shares | ||
12 |
Count of comments | ||
13 |
Count of followers | ||
14 |
Engagement rate |
First, format the structure to an URL-encoded string:
filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/mentions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
curl -G https://data.neticle.com/22.09/mentions \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'filters[aspects][0]=10001_20002'\ -d 'filters[keywords][0]=10001'\ -d 'filters[keywords][1]=10002'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/mentions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/mentions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/mentions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/mentions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention[] |
The resource model(s). | |
meta |
MentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the mentions | |
relatedResources |
null | RelatedResourceMap |
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by MentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention[] |
The resource model(s). | |
meta |
MentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the mentions | |
relatedResources |
null | RelatedResourceMap |
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by MentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention[] |
The resource model(s). | |
meta |
MentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the mentions | |
relatedResources |
null | RelatedResourceMap |
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by MentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
Finding a single mention
GET /mentions/:mentionId
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
PartialPresentation
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
presentation omittable |
RelatedResourcesPresentation |
A structure that influences how your data will be presented. |
{
"presentation": {
"includeResourceMap": false
}
}
Referenced entities by PartialPresentation
First, format the structure to an URL-encoded string:
presentation[includeResourceMap]=false
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/mentions/:mentionid?presentation[includeResourceMap]=false
curl -G https://data.neticle.com/22.09/mentions/:mentionId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'presentation[includeResourceMap]=false'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/mentions/:mentionId?presentation[includeResourceMap]=false', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/mentions/:mentionId?presentation[includeResourceMap]=false") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/mentions/:mentionId?presentation[includeResourceMap]=false" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/mentions/:mentionId?presentation[includeResourceMap]=false', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention |
The resource model(s). | |
meta |
SingleMentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
relatedResources |
RelatedResourceMap |
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap) |
{
"relatedResources": null
}
Referenced entities by SingleMentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention |
The resource model(s). | |
meta |
SingleMentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
relatedResources |
RelatedResourceMap |
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap) |
{
"relatedResources": null
}
Referenced entities by SingleMentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Mention |
The resource model(s). | |
meta |
SingleMentionMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
string |
The identifier of the mention | |
url |
string |
The source url of this mention. | |
title |
string |
The title of the mention. | |
author |
string |
The name of the author of this mention. | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT. | |
textOriginal |
string |
The contents of this mention (plain text) | |
textFormatted |
string |
The contents of this mention (negative/positive phrases, links, etc. are decorated by html tags). | |
aspectId |
null | string |
The identifier of the aspect this mention belongs to. | |
keywordId |
number |
The identifier of the keyword this mention belongs to. | |
genderId |
GenderGroup |
A gender identifier this mention's author was identified as. | |
sourceId |
number |
The identifier of the source this mention belongs to. | |
languageId |
number |
The identifier of the mention's language. | |
subSourceId |
number |
The identifier of the sub-source this mention belongs to. | |
ownChannelId |
null | number |
The identifier of the own channel this mention belongs to. | |
cityId |
null | number |
The identifier of the mention's city. | |
regionId |
null | number |
The identifier of the mention's region. | |
topicLabelIds |
number[] |
Topic-related labels | |
brandLabelIds |
number[] |
Brand-related labels | |
personLabelIds |
number[] |
Person-related labels | |
emotionLabelIds |
number[] |
Emotion-related labels | |
locationLabelIds |
number[] |
Location-related labels | |
attributeLabelIds |
number[] |
Attribute-related labels | |
organizationLabelIds |
number[] |
Organization-related labels | |
domain |
string |
The source domain of this mention. | |
polarity |
number |
The overall sentiment of the mention. | |
hash |
string |
The hash of the contents of this mention | |
note |
string |
User-added note on the mention. | |
thumbnailUrl |
string|null |
The url of the mention's thumbnail. | |
reach |
number |
- | |
latitude |
number |
- | |
longitude |
number |
- | |
importance |
null | number |
An unsigned int score indicating the importance of this mention. NULL means that it cannot be determined. | |
isMarked |
boolean |
Was this mention marked by a user? | |
relatedUrl |
string |
The attached/linked external URL in case of (for example) facebook posts/comments. | |
sumLikes |
number |
The like count of this mention. | |
sumShares |
number |
The share count of this mention. | |
sumComments |
number |
The number of comments on this mention. | |
sumFollowers |
number |
The follower number of the mention's author. | |
sumInteractions |
number |
The interaction count of this mention. | |
sumDislikes |
number |
The dislike count of this mention. | |
sumReactions |
number |
The reaction count of this mention. | |
engagementRate |
number |
The engagement rate of this mention. | |
facebookDetails |
null | FacebookDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
instagramDetails |
null | InstagramDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
twitterDetails |
null | TwitterDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
youtubeDetails |
null | YouTubeDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
tiktokDetails |
null | TiktokDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
reviewDetails |
null | ReviewDetails |
Is null when the sum of it's fields is 0 (to save on json size). | |
contentLength |
number |
The length of the mention's original text. | |
urlAttachments |
string[] |
Any links that have been attached to this mention. | |
imageAttachments |
string[] |
Any images URLs that have been attached to this mention. | |
videoAttachments |
string[] |
Any video URLs that have been attached to this mention. |
{
"id": "0-0",
"url": "some.domain.net/xyz",
"title": "Title of the mention",
"author": "Anonymous",
"createdAtUtcMs": 0,
"textOriginal": "The contents of the mention.",
"textFormatted": "The <span>contents</span> of the mention.",
"aspectId": 0,
"keywordId": 0,
"genderId": 0,
"sourceId": 10,
"languageId": 0,
"subSourceId": null,
"ownChannelId": null,
"cityId": null,
"regionId": null,
"topicLabelIds": [],
"brandLabelIds": [],
"personLabelIds": [],
"emotionLabelIds": [],
"locationLabelIds": [],
"attributeLabelIds": [],
"organizationLabelIds": [],
"domain": "some.domain.net",
"polarity": 0,
"hash": "asd976asd764asd746a7sd657asd65a7sd",
"note": "",
"thumbnailUrl": "",
"reach": 0,
"latitude": null,
"longitude": null,
"importance": null,
"isMarked": false,
"relatedUrl": "",
"sumLikes": 0,
"sumShares": 0,
"sumComments": 0,
"sumFollowers": 0,
"sumInteractions": 0,
"sumDislikes": 0,
"sumReactions": 0,
"engagementRate": 0,
"facebookDetails": null,
"instagramDetails": null,
"twitterDetails": null,
"youtubeDetails": null,
"tiktokDetails": null,
"reviewDetails": {
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
},
"contentLength": 0,
"urlAttachments": [
"https://telex.hu/podcast/2023/07/13/after-aranylemez-slagerlista-mezei-csaba"
],
"imageAttachments": [
"https://dn04sjp2vurmz.cloudfront.net/fb2328555b91f2/6a56/548b/8192/435078e28e78.jpg?x-key=0Tw5gG2rplsH&Expires=1689232371&Signature=UK0GmBQi0ffJ~dvMzcMTySxMgKeXK8KqOFwhgY9qIT4cAFavcNRVYU~z6ERfP5K81-DSQJ3s~DWVzS20mak2a3Spi0uOqz8W0f6FGkSZqW7iSJm67P6EU8T1QgCQ1tuGAxFERDGaHWpRARn~NYdNC1WVC9pQP04R0gAHRgTWMzIZFeE5TKMSS8TA-O9KZeUcherujrNm1WZ6bCTMtnfqDklCiwBIkxXG9KT5HVYT3v-THJ6ED2qjukIhNxjTA8cnZWNbG~GumwAauAlL~depwkWilyJXujBwXMnOEZkIviIiaD~MU~1DuKLHCery7ux67eag-cK~K9sIo1XLV01kNQ__&Key-Pair-Id=K3JFZLB7EUKC2M"
],
"videoAttachments": [
"https://www.facebook.com/316463203625299/videos/654117656586322"
]
}
Referenced entities by Mention
Property | Type | Comment | |
---|---|---|---|
angry |
number |
The count of angry reactions on this mention. | |
care |
number |
The count of care reactions on this mention. | |
haha |
number |
The count of haha reactions on this mention. | |
love |
number |
The count of love reactions on this mention. | |
sad |
number |
The count of sad reactions on this mention. | |
wow |
number |
The count of wow reactions on this mention. | |
fan |
number |
The count of fans on this page. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
reply |
number |
The count of replies on this mention. | |
comment |
number |
The count of comments on this mention. |
{
"angry": 0,
"care": 0,
"haha": 0,
"love": 0,
"sad": 0,
"wow": 0,
"fan": 0,
"like": 0,
"share": 0,
"reply": 0,
"comment": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes of this mention. | |
view |
number |
The count of views of this mention. | |
score |
number |
The count of scores of this mention. | |
comment |
number |
The count of comments of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"view": 0,
"score": 0,
"comment": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
like |
number |
The count of likes on this mention. | |
comment |
number |
The count of comments on this mention. | |
retweet |
number |
The number of retweets of this mention. | |
follower |
number |
The count of followers of the author. |
{
"like": 0,
"comment": 0,
"retweet": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
dislike |
number |
The count of dislikes on this mention. | |
comment |
number |
The count of comments on this mention. | |
subscribe |
number |
The count of subscriptions on the channel. |
{
"view": 0,
"like": 0,
"dislike": 0,
"comment": 0,
"subscribe": 0
}
Property | Type | Comment | |
---|---|---|---|
view |
number |
The count of views on this mention. | |
like |
number |
The count of likes on this mention. | |
share |
number |
The count of shares on this mention. | |
follower |
number |
The count of followers of the author. |
{
"view": 0,
"like": 0,
"share": 0,
"follower": 0
}
Property | Type | Comment | |
---|---|---|---|
upvote |
number |
The count of upvotes on this mention. | |
downvote |
number |
The count of downvotes on this mention. | |
starRatingMax |
number |
The maximum stars one can give. | |
starRatingScore |
number |
The count of stars this mention got. | |
starRatingVersion |
string |
The version this mention is associated to. |
{
"upvote": 0,
"downvote": 2,
"starRatingMax": null,
"starRatingScore": null,
"starRatingVersion": null
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Property | Type | Comment | |
---|---|---|---|
relatedResources |
RelatedResourceMap |
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap) |
{
"relatedResources": null
}
Referenced entities by SingleMentionMeta
Property | Type | Comment | |
---|---|---|---|
labels |
ByLabelTypes<Record<number, Label>> |
Map of the labels that appeared in the mentions | |
sources |
Record<number, Source> |
Map of the sources that appeared in the mentions | |
aspects |
Record<number, Aspect> |
Map of the aspects that appeared in the mentions | |
keywords |
Record<number, Keyword> |
Map of the keywords that appeared in the mentions | |
ownChannels |
Record<number, OwnChannel> |
Map of the own channels that appeared in the mentions | |
genders |
Record<number, GenderRecord> |
Map of the genders that appeared in the mentions | |
languages |
Record<number, Language> |
Map of the languages the mentions appeared in | |
cities |
Record<number, City> |
Map of the cities the mentions are from | |
regions |
Record<number, Region> |
Map of the regions the mentions are from |
{
"labels": {
"topic": {
"0": {
"id": 0,
"label": "demo label"
}
},
"brand": {
"0": {
"id": 0,
"label": "demo label"
}
},
"person": {
"0": {
"id": 0,
"label": "demo label"
}
},
"emotion": {
"0": {
"id": 0,
"label": "demo label"
}
},
"location": {
"0": {
"id": 0,
"label": "demo label"
}
},
"attribute": {
"0": {
"id": 0,
"label": "demo label"
}
},
"organization": {
"0": {
"id": 0,
"label": "demo label"
}
}
},
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"ownChannels": {
"0": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
},
"genders": {
"2": {
"id": 2,
"name": "male",
"label": "Male"
}
},
"languages": {
"0": {
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
},
"cities": {
"0": {
"id": 0,
"label": "Budapest",
"countryId": 1
}
},
"regions": {
"0": {
"id": 0,
"label": "Pest",
"countryId": 1
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the gender | |
name |
string |
An internal name for the gender | |
label |
string |
A displayable name of the gender |
{
"id": 2,
"name": "male",
"label": "Male"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Property | Type | Comment | |
---|---|---|---|
topic |
Label |
Topic labels that appeared in the mentions | |
brand |
Label |
Brand labels that appeared in the mentions | |
person |
Label |
Person labels that appeared in the mentions | |
emotion |
Label |
Emotion labels that appeared in the mentions | |
location |
Label |
Location labels that appeared in the mentions | |
attribute |
Label |
Attribute labels that appeared in the mentions | |
organization |
Label |
Organization labels that appeared in the mentions |
{
"topic": {
"id": 0,
"label": "demo label"
},
"brand": {
"id": 0,
"label": "demo label"
},
"person": {
"id": 0,
"label": "demo label"
},
"emotion": {
"id": 0,
"label": "demo label"
},
"location": {
"id": 0,
"label": "demo label"
},
"attribute": {
"id": 0,
"label": "demo label"
},
"organization": {
"id": 0,
"label": "demo label"
}
}
Referenced entities by ByLabelTypes
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the language | |
label |
string |
A displayable name of the language | |
isoCode2 |
string |
The 2-letter ISO code of the language | |
neticleCode |
string |
An internal code for the language |
{
"id": 0,
"label": "Ukrainian",
"isoCode2": "uk",
"neticleCode": "ua"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the city | |
label |
string |
A displayable name of the city | |
countryId |
string |
The identifier of the city's country |
{
"id": 0,
"label": "Budapest",
"countryId": 1
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the region | |
label |
string |
A displayable name of the region | |
countryId |
string |
The identifier of the region's country |
{
"id": 0,
"label": "Pest",
"countryId": 1
}
Example:
{
"id": 0,
"label": "demo label"
}
Keywords
Provides an interface to interact with the keyword objects stored in our databases.
Listing keywords
GET /keywords
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. | |
keywordGroupId omittable |
number |
Filter by a keyword group. |
{
"clientId": 0,
"profileId": 0,
"keywordGroupId": 0
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0&keywordGroupId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/keywords?clientId=0&profileId=0&keywordGroupId=0
curl -G https://data.neticle.com/22.09/keywords \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'\ -d 'keywordGroupId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/keywords?clientId=0&profileId=0&keywordGroupId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/keywords?clientId=0&profileId=0&keywordGroupId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/keywords?clientId=0&profileId=0&keywordGroupId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/keywords?clientId=0&profileId=0&keywordGroupId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Finding a single keyword
GET /keywords/:keywordId
curl -G https://data.neticle.com/22.09/keywords/:keywordId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/keywords/:keywordId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/keywords/:keywordId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/keywords/:keywordId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/keywords/:keywordId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Keyword |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Profiles
Provides an interface to interact with the profile objects stored in our databases.
Listing profiles
GET /profiles
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. |
{
"clientId": 0
}
First, format the structure to an URL-encoded string:
clientId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/profiles?clientId=0
curl -G https://data.neticle.com/22.09/profiles \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/profiles?clientId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/profiles?clientId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/profiles?clientId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/profiles?clientId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Finding a single profile
GET /profiles/:profileId
curl -G https://data.neticle.com/22.09/profiles/:profileId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/profiles/:profileId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/profiles/:profileId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/profiles/:profileId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/profiles/:profileId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Profile |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Insights
Provides an interface to interact with the insight objects stored in our databases.
Listing insights
GET /insights
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
InsightView
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
filters required |
InsightViewFilter |
A structure that influences the multiplicity of the results. | |
presentation omittable |
InsightPresentation |
A structure that influences how your data will be presented.
Default:
|
{
"filters": {
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
],
"interval": {
"end": 1650978557230,
"start": 1649768957230
}
}
}
Referenced entities by InsightView
Property | Type | Comment | |
---|---|---|---|
aspects required |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords required |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval required |
IntervalFilter |
The timestamps to search beween. | |
sources omittable |
SourceGroup[] |
Filters between the content sources. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
],
"interval": {
"end": 1650978557230,
"start": 1649768957230
}
}
Referenced entities by InsightViewFilter
Property | Type | Comment | |
---|---|---|---|
end required |
number |
The latest time in milliseconds. | |
start required |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Property | Type | Comment | |
---|---|---|---|
currentPage omittable |
number |
Controls from which page the result set will be returned
Default:
|
|
numberOfValues omittable |
number |
The number of mentions per page
Default:
|
|
includeResourceMap omittable |
boolean |
Toggles whether the response should include a lookup map for all the resource IDs as a meta object.
Default:
|
{
"currentPage": 1,
"numberOfValues": 100,
"includeResourceMap": false
}
First, format the structure to an URL-encoded string:
filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/insights?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230
curl -G https://data.neticle.com/22.09/insights \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'filters[aspects][0]=10001_20002'\ -d 'filters[keywords][0]=10001'\ -d 'filters[keywords][1]=10002'\ -d 'filters[interval][end]=1650978557230'\ -d 'filters[interval][start]=1649768957230'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/insights?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/insights?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/insights?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/insights?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002&filters[interval][end]=1650978557230&filters[interval][start]=1649768957230', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Insight[] |
The resource model(s). | |
meta |
InsightsMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the insight | |
aspectId |
string | null |
The identifier of the aspect this insight belongs to | |
keywordId |
number |
The identifier of the keyword this insight belongs to | |
sourceId |
number | null |
The identifier of the source this insight belongs to | |
type |
string |
The type of the insight | |
entity |
string | null |
The subject of the insight | |
mentionIds |
number[] |
The related mentions | |
previousValue |
number |
The previous value (number of mentions, reach, web opinion index etc.) | |
currentValue |
number |
The current value (number of mentions, reach, web opinion index etc.) | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT | |
description |
InsightDescription |
- |
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
Referenced entities by Insight
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the insights | |
relatedResources |
InsightsRelatedResourceMap |
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by InsightsMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
Map of the sources the insights belong to | |
aspects |
Record<number, Aspect> |
Map of the aspects the insights belong to | |
keywords |
Record<number, Keyword> |
Map of the keywords the insights belong to |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
}
}
Referenced entities by InsightsRelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Insight[] |
The resource model(s). | |
meta |
InsightsMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the insight | |
aspectId |
string | null |
The identifier of the aspect this insight belongs to | |
keywordId |
number |
The identifier of the keyword this insight belongs to | |
sourceId |
number | null |
The identifier of the source this insight belongs to | |
type |
string |
The type of the insight | |
entity |
string | null |
The subject of the insight | |
mentionIds |
number[] |
The related mentions | |
previousValue |
number |
The previous value (number of mentions, reach, web opinion index etc.) | |
currentValue |
number |
The current value (number of mentions, reach, web opinion index etc.) | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT | |
description |
InsightDescription |
- |
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
Referenced entities by Insight
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the insights | |
relatedResources |
InsightsRelatedResourceMap |
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by InsightsMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
Map of the sources the insights belong to | |
aspects |
Record<number, Aspect> |
Map of the aspects the insights belong to | |
keywords |
Record<number, Keyword> |
Map of the keywords the insights belong to |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
}
}
Referenced entities by InsightsRelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Insight[] |
The resource model(s). | |
meta |
InsightsMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
],
"meta": {
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the insight | |
aspectId |
string | null |
The identifier of the aspect this insight belongs to | |
keywordId |
number |
The identifier of the keyword this insight belongs to | |
sourceId |
number | null |
The identifier of the source this insight belongs to | |
type |
string |
The type of the insight | |
entity |
string | null |
The subject of the insight | |
mentionIds |
number[] |
The related mentions | |
previousValue |
number |
The previous value (number of mentions, reach, web opinion index etc.) | |
currentValue |
number |
The current value (number of mentions, reach, web opinion index etc.) | |
createdAtUtcMs |
number |
The creation time in milliseconds, GMT | |
description |
InsightDescription |
- |
{
"id": 0,
"aspectId": null,
"keywordId": 0,
"sourceId": 0,
"type": "",
"entity": null,
"mentionIds": [],
"previousValue": 0,
"currentValue": 0,
"createdAtUtcMs": 0,
"description": {
"title": "Title of the insight",
"text": "Text of the insight"
}
}
Referenced entities by Insight
Property | Type | Comment | |
---|---|---|---|
pagination |
Pagination |
Pagination for the insights | |
relatedResources |
InsightsRelatedResourceMap |
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap) |
{
"pagination": {
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
},
"relatedResources": null
}
Referenced entities by InsightsMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
Map of the sources the insights belong to | |
aspects |
Record<number, Aspect> |
Map of the aspects the insights belong to | |
keywords |
Record<number, Keyword> |
Map of the keywords the insights belong to |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"aspects": {
"0_0": {
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
},
"keywords": {
"0": {
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
}
}
Referenced entities by InsightsRelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
to |
number |
The placement of the last mention in the order | |
from |
number |
The placement of the first mention in the order | |
total |
number |
The number of mentions in total that satisfied the original filter conditions | |
perPage |
number |
The number of mentions per page | |
currentPage |
number |
The current page number | |
lastPage |
number |
The last page number | |
queryParams |
QueryParams |
Query strings |
{
"to": 100,
"from": 1,
"total": 300,
"perPage": 100,
"currentPage": 1,
"lastPage": 1,
"queryParams": {
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
}
Referenced entities by Pagination
Property | Type | Comment | |
---|---|---|---|
lastPage |
string |
- | |
nextPage |
string |
- | |
firstPage |
string |
- | |
previousPage |
string |
- |
{
"lastPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=47",
"nextPage": "?filters[keywords][0]=10088&filters[interval][end]=1662641856919&filters[interval][start]=1661432256919&presentation[currentPage]=2",
"firstPage": "?filters[keywords][0]=10088&filters[interval][end]=1662642811176&filters[interval][start]=1661433211176",
"previousPage": ""
}
Resources
Provides an interface to interact with the resources stored in our databases.
Listing resources
GET /resources
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. | |
keywordGroupId omittable |
number |
Filter by a keyword group. | |
aspectGroupId omittable |
number |
Filter by an aspect group. | |
keywordId omittable |
number |
Filter by a keyword. | |
aspectId omittable |
string |
Filter by an aspect. |
{
"clientId": 0,
"profileId": 0,
"keywordGroupId": 0,
"aspectGroupId": 0,
"keywordId": 0,
"aspectId": "0_0"
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/resources?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0
curl -G https://data.neticle.com/22.09/resources \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'\ -d 'keywordGroupId=0'\ -d 'aspectGroupId=0'\ -d 'keywordId=0'\ -d 'aspectId=0_0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/resources?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/resources?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/resources?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/resources?clientId=0&profileId=0&keywordGroupId=0&aspectGroupId=0&keywordId=0&aspectId=0_0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Resources |
The resource model(s). | |
meta |
ResourcesMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
clients |
Client[] |
Available clients | |
aspects |
Aspect[] |
Available aspects | |
keywords |
Keyword[] |
Available keywords | |
profiles |
Profile[] |
Available profiles | |
aspectGroups |
AspectGroup[] |
Available aspect groups | |
keywordGroups |
KeywordGroup[] |
Available keyword groups |
{
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
}
Referenced entities by Resources
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
relatedResources |
null | RelatedResourceMap |
When enabled, contains lookup maps to referenced resource models. |
{
"relatedResources": null
}
Referenced entities by ResourcesMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
A lookup map from source id to source model. | |
countries |
Record<number, Country> |
A lookup map from country id to country model. |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"countries": {
"0": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Resources |
The resource model(s). | |
meta |
ResourcesMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
clients |
Client[] |
Available clients | |
aspects |
Aspect[] |
Available aspects | |
keywords |
Keyword[] |
Available keywords | |
profiles |
Profile[] |
Available profiles | |
aspectGroups |
AspectGroup[] |
Available aspect groups | |
keywordGroups |
KeywordGroup[] |
Available keyword groups |
{
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
}
Referenced entities by Resources
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
relatedResources |
null | RelatedResourceMap |
When enabled, contains lookup maps to referenced resource models. |
{
"relatedResources": null
}
Referenced entities by ResourcesMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
A lookup map from source id to source model. | |
countries |
Record<number, Country> |
A lookup map from country id to country model. |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"countries": {
"0": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Resources |
The resource model(s). | |
meta |
ResourcesMeta |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
},
"meta": {
"relatedResources": null
},
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
clients |
Client[] |
Available clients | |
aspects |
Aspect[] |
Available aspects | |
keywords |
Keyword[] |
Available keywords | |
profiles |
Profile[] |
Available profiles | |
aspectGroups |
AspectGroup[] |
Available aspect groups | |
keywordGroups |
KeywordGroup[] |
Available keyword groups |
{
"clients": [
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspects": [
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"keywords": [
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
],
"profiles": [
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"aspectGroups": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"keywordGroups": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
]
}
Referenced entities by Resources
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the client. | |
name |
string |
An internal name for the model. | |
label |
string |
The user-displayable name of the client. | |
countryId |
number |
The id of the country this client belongs to. | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "en_demo",
"label": "Demo client",
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
string |
The composite identifier of this object. | |
name |
string |
The internal name of the aspect. | |
label |
string |
A displayable name of the aspect. | |
keywordId |
number |
The keyword's id this aspect is related to. | |
profileId |
number |
The id of the profile this aspect belongs to. | |
aspectGroupId |
number |
The aspect group's id this aspect is related to. | |
keywordGroupId |
number |
The id of the group this aspect belongs to. | |
clientId |
number |
The id of the client this aspect belongs to. | |
countryId |
number |
The id of the country this aspect belongs to. | |
ianaTimeZone |
string |
The IANA time zone if the keyword this aspect belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this aspect's keyword's valid sources. | |
color |
string |
The color of the aspect |
{
"id": "0_0",
"name": "demokeyw_demas",
"label": "Demo keyword - Demo aspect",
"keywordId": 0,
"profileId": 0,
"aspectGroupId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword | |
name |
string |
An internal name for the keyword | |
label |
string |
A displayable name of the keyword | |
profileId |
number |
The id of the profile this keyword belongs to. | |
keywordGroupId |
number |
The id of the group this keyword belongs to. | |
clientId |
number |
The id of the client this keyword belongs to. | |
countryId |
number |
The id of the country this keyword belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. | |
sourceIds |
number[] |
The ids of this keyword's valid sources. | |
color |
string |
The color of the keyword |
{
"id": 0,
"name": "demokeyw",
"label": "Demo keyword",
"profileId": 0,
"keywordGroupId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
],
"sourceIds": [],
"color": "#0099FF"
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the profile instance. | |
label |
string |
The user-displayable name of the profile. | |
clientId |
number |
The id of the client this profile belongs to. | |
countryId |
number |
The id of the country this profile belongs to. | |
ianaTimeZone |
string |
The IANA time zone this profile belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo profile",
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Property | Type | Comment | |
---|---|---|---|
relatedResources |
null | RelatedResourceMap |
When enabled, contains lookup maps to referenced resource models. |
{
"relatedResources": null
}
Referenced entities by ResourcesMeta
Property | Type | Comment | |
---|---|---|---|
sources |
Record<number, Source> |
A lookup map from source id to source model. | |
countries |
Record<number, Country> |
A lookup map from country id to country model. |
{
"sources": {
"6": {
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
},
"countries": {
"0": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
}
}
Referenced entities by RelatedResourceMap
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the source | |
name |
string |
An internal name for the source | |
order |
number |
The order of the source | |
color |
string |
The color of the source | |
isGroup |
boolean |
- | |
isEnabled |
boolean |
- | |
sourceCode |
number |
An internal code for the source | |
parentSourceId |
null | number |
The id of the source this source is a member of. |
{
"id": 6,
"name": "forum",
"order": 5,
"color": "#9F20C1",
"isGroup": 1,
"isEnabled": 1,
"sourceCode": 2,
"parentSourceId": null
}
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
Countries
Provides an interface to interact with the country objects stored in our databases.
Listing countries
GET /countries
curl -G https://data.neticle.com/22.09/countries \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/countries', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/countries") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/countries" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/countries', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
Finding a single country
GET /countries/:countryId
curl -G https://data.neticle.com/22.09/countries/:countryId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/countries/:countryId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/countries/:countryId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/countries/:countryId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/countries/:countryId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
Country |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the country | |
label |
string |
A displayable name of the country | |
isoCode2 |
string |
The 2-letter ISO code of the country | |
neticleCode |
string |
An internal code for the country | |
ianaTimeZone |
string |
The IANA time zone this client belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "United Kingdom",
"isoCode2": "gb",
"neticleCode": "uk",
"ianaTimeZone": "Europe/London",
"ianaLanguages": [
"en"
]
}
Aggregations
Provides an interface to interact with the aggregations of the given mentions.
KPIs
GET /mentions/aggregation/kpis
This is an endpoint that will return the KPIs for every keyword and/or aspect you specify in the filter structure.
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
Filters
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
filters required |
ViewFilter |
A structure that influences the multiplicity of the results. |
{
"filters": {
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
}
Referenced entities by Filters
Property | Type | Comment | |
---|---|---|---|
aspects required |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords required |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval omittable |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) The maximum allowed time interval is 30 days. |
|
sources omittable |
SourceGroup[] |
Filters between the content sources.
Default:
|
|
genders omittable |
GenderGroup[] |
Filters for the gender of the author.
Default:
|
|
polarities omittable |
PolarityGroup[] |
Filters for sentiment between the results.
Default:
|
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end required |
number |
The latest time in milliseconds. | |
start required |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
First, format the structure to an URL-encoded string:
filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/mentions/aggregation/kpis?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
curl -G https://data.neticle.com/22.09/mentions/aggregation/kpis \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'filters[aspects][0]=10001_20002'\ -d 'filters[keywords][0]=10001'\ -d 'filters[keywords][1]=10002'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/mentions/aggregation/kpis?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/mentions/aggregation/kpis?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/mentions/aggregation/kpis?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/mentions/aggregation/kpis?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KPIs |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The number of mentions in total that satisfied the filter conditions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumInteractions |
number |
The sum of the mentions' interactions | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes | |
bySources |
Record<SourceGroup, AggregationDetails> |
KPIs by source types | |
bySubSources |
Record<SourceGroup, AggregationDetails> |
KPIs by sub source types | |
byPolarities |
Record<PolarityGroup, AggregationDetails> |
KPIs by polarity types |
{
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
}
Referenced entities by KPIs
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The total number of mentions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes |
{
"sumCount": 0,
"sumReach": 0,
"sumPolarityIndex": 0
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KPIs |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The number of mentions in total that satisfied the filter conditions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumInteractions |
number |
The sum of the mentions' interactions | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes | |
bySources |
Record<SourceGroup, AggregationDetails> |
KPIs by source types | |
bySubSources |
Record<SourceGroup, AggregationDetails> |
KPIs by sub source types | |
byPolarities |
Record<PolarityGroup, AggregationDetails> |
KPIs by polarity types |
{
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
}
Referenced entities by KPIs
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The total number of mentions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes |
{
"sumCount": 0,
"sumReach": 0,
"sumPolarityIndex": 0
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KPIs |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The number of mentions in total that satisfied the filter conditions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumInteractions |
number |
The sum of the mentions' interactions | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes | |
bySources |
Record<SourceGroup, AggregationDetails> |
KPIs by source types | |
bySubSources |
Record<SourceGroup, AggregationDetails> |
KPIs by sub source types | |
byPolarities |
Record<PolarityGroup, AggregationDetails> |
KPIs by polarity types |
{
"sumCount": 0,
"sumReach": 0,
"sumInteractions": 0,
"sumPolarityIndex": 0,
"bySources": {},
"bySubSources": {},
"byPolarities": {}
}
Referenced entities by KPIs
Property | Type | Comment | |
---|---|---|---|
sumCount |
number |
The total number of mentions | |
sumReach |
number |
The sum of the mentions' reach values | |
sumPolarityIndex |
number |
The sum of the mentions' polarity indexes |
{
"sumCount": 0,
"sumReach": 0,
"sumPolarityIndex": 0
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Interactions
GET /mentions/aggregation/interactions
This is an endpoint that will return the interactions for every keyword and/or aspect you specify in the filter structure.
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
Filters
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
filters required |
ViewFilter |
A structure that influences the multiplicity of the results. |
{
"filters": {
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
}
Referenced entities by Filters
Property | Type | Comment | |
---|---|---|---|
aspects required |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords required |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval omittable |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) The maximum allowed time interval is 30 days. |
|
sources omittable |
SourceGroup[] |
Filters between the content sources.
Default:
|
|
genders omittable |
GenderGroup[] |
Filters for the gender of the author.
Default:
|
|
polarities omittable |
PolarityGroup[] |
Filters for sentiment between the results.
Default:
|
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end required |
number |
The latest time in milliseconds. | |
start required |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
First, format the structure to an URL-encoded string:
filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/mentions/aggregation/interactions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
curl -G https://data.neticle.com/22.09/mentions/aggregation/interactions \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'filters[aspects][0]=10001_20002'\ -d 'filters[keywords][0]=10001'\ -d 'filters[keywords][1]=10002'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/mentions/aggregation/interactions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/mentions/aggregation/interactions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/mentions/aggregation/interactions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/mentions/aggregation/interactions?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
InteractionAggregation |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumFbLikes |
number |
The sum of Facebook likes | |
sumFbReplies |
number |
The sum of Facebook replies | |
sumFbShares |
number |
The sum of Facebook shares | |
sumFbComments |
number |
The sum of Facebook comments | |
sumFbSads |
number |
The sum of Facebook sad reactions | |
sumFbWows |
number |
The sum of Facebook wow reactions | |
sumFbCares |
number |
The sum of Facebook care reactions | |
sumFbHahas |
number |
The sum of Facebook haha reactions | |
sumFbLoves |
number |
The sum of Facebook love reactions | |
sumFbAngries |
number |
The sum of Facebook angry reactions | |
sumIgLikes |
number |
The sum of Instagram likes | |
sumIgScores |
number |
The sum of Instagram scores | |
sumIgComments |
number |
The sum of Instagram comments | |
sumTwLikes |
number |
The sum of Twitter likes | |
sumTwComments |
number |
The sum of Twitter comments | |
sumTwRetweets |
number |
The sum of Twitter retweets | |
sumYtLikes |
number |
The sum of Youtube likes | |
sumYtComments |
number |
The sum of Youtube comments | |
sumYtDislikes |
number |
The sum of Youtube dislikes | |
sumTtLikes |
number |
The sum of Tiktok likes | |
sumTtShares |
number |
The sum of Tiktok shares | |
sumPiLikes |
number |
The sum of Pinterest likes | |
sumReviewUpvotes |
number |
The sum of review upvotes | |
sumReviewDownvotes |
number |
The sum of review downvotes |
{
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
InteractionAggregation |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumFbLikes |
number |
The sum of Facebook likes | |
sumFbReplies |
number |
The sum of Facebook replies | |
sumFbShares |
number |
The sum of Facebook shares | |
sumFbComments |
number |
The sum of Facebook comments | |
sumFbSads |
number |
The sum of Facebook sad reactions | |
sumFbWows |
number |
The sum of Facebook wow reactions | |
sumFbCares |
number |
The sum of Facebook care reactions | |
sumFbHahas |
number |
The sum of Facebook haha reactions | |
sumFbLoves |
number |
The sum of Facebook love reactions | |
sumFbAngries |
number |
The sum of Facebook angry reactions | |
sumIgLikes |
number |
The sum of Instagram likes | |
sumIgScores |
number |
The sum of Instagram scores | |
sumIgComments |
number |
The sum of Instagram comments | |
sumTwLikes |
number |
The sum of Twitter likes | |
sumTwComments |
number |
The sum of Twitter comments | |
sumTwRetweets |
number |
The sum of Twitter retweets | |
sumYtLikes |
number |
The sum of Youtube likes | |
sumYtComments |
number |
The sum of Youtube comments | |
sumYtDislikes |
number |
The sum of Youtube dislikes | |
sumTtLikes |
number |
The sum of Tiktok likes | |
sumTtShares |
number |
The sum of Tiktok shares | |
sumPiLikes |
number |
The sum of Pinterest likes | |
sumReviewUpvotes |
number |
The sum of review upvotes | |
sumReviewDownvotes |
number |
The sum of review downvotes |
{
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
InteractionAggregation |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
sumFbLikes |
number |
The sum of Facebook likes | |
sumFbReplies |
number |
The sum of Facebook replies | |
sumFbShares |
number |
The sum of Facebook shares | |
sumFbComments |
number |
The sum of Facebook comments | |
sumFbSads |
number |
The sum of Facebook sad reactions | |
sumFbWows |
number |
The sum of Facebook wow reactions | |
sumFbCares |
number |
The sum of Facebook care reactions | |
sumFbHahas |
number |
The sum of Facebook haha reactions | |
sumFbLoves |
number |
The sum of Facebook love reactions | |
sumFbAngries |
number |
The sum of Facebook angry reactions | |
sumIgLikes |
number |
The sum of Instagram likes | |
sumIgScores |
number |
The sum of Instagram scores | |
sumIgComments |
number |
The sum of Instagram comments | |
sumTwLikes |
number |
The sum of Twitter likes | |
sumTwComments |
number |
The sum of Twitter comments | |
sumTwRetweets |
number |
The sum of Twitter retweets | |
sumYtLikes |
number |
The sum of Youtube likes | |
sumYtComments |
number |
The sum of Youtube comments | |
sumYtDislikes |
number |
The sum of Youtube dislikes | |
sumTtLikes |
number |
The sum of Tiktok likes | |
sumTtShares |
number |
The sum of Tiktok shares | |
sumPiLikes |
number |
The sum of Pinterest likes | |
sumReviewUpvotes |
number |
The sum of review upvotes | |
sumReviewDownvotes |
number |
The sum of review downvotes |
{
"sumFbLikes": 0,
"sumFbReplies": 0,
"sumFbShares": 0,
"sumFbComments": 0,
"sumFbSads": 0,
"sumFbWows": 0,
"sumFbCares": 0,
"sumFbHahas": 0,
"sumFbLoves": 0,
"sumFbAngries": 0,
"sumIgLikes": 0,
"sumIgScores": 0,
"sumIgComments": 0,
"sumTwLikes": 0,
"sumTwComments": 0,
"sumTwRetweets": 0,
"sumYtLikes": 0,
"sumYtComments": 0,
"sumYtDislikes": 0,
"sumTtLikes": 0,
"sumTtShares": 0,
"sumPiLikes": 0,
"sumReviewUpvotes": 0,
"sumReviewDownvotes": 0
}
Own channels
Provides an interface to interact with the own channel objects stored in our databases.
Listing own channels
GET /own-channels
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. | |
keywordGroupId omittable |
number |
Filter by a keyword group. | |
keywordId omittable |
number |
Filter by a keyword. |
{
"clientId": 0,
"profileId": 0,
"keywordGroupId": 0,
"keywordId": 0
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0&keywordGroupId=0&keywordId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/own-channels?clientId=0&profileId=0&keywordGroupId=0&keywordId=0
curl -G https://data.neticle.com/22.09/own-channels \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'\ -d 'keywordGroupId=0'\ -d 'keywordId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/own-channels?clientId=0&profileId=0&keywordGroupId=0&keywordId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/own-channels?clientId=0&profileId=0&keywordGroupId=0&keywordId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/own-channels?clientId=0&profileId=0&keywordGroupId=0&keywordId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/own-channels?clientId=0&profileId=0&keywordGroupId=0&keywordId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Finding a single own channel
GET /own-channels/:ownChannelId
curl -G https://data.neticle.com/22.09/own-channels/:ownChannelId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/own-channels/:ownChannelId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/own-channels/:ownChannelId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/own-channels/:ownChannelId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/own-channels/:ownChannelId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
OwnChannel |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the own channel instance. | |
type |
string |
The type of the own channel. | |
keywordId |
number |
The id of the keyword this own channel belongs to. | |
keywordGroupId |
number |
The id of the group this own channel belongs to. | |
profileId |
number |
The id of the profile this own channel belongs to. | |
clientId |
number |
The id of the client this own channel belongs to. | |
countryId |
number |
The id of the country this own channel belongs to. | |
channelId |
string |
The channel's identifier on its original source. | |
channelName |
string |
The name of the channel. | |
createdAt |
number |
The date of creation in milliseconds. | |
createdBy |
number |
The id of the creator. | |
additionalInfo |
string |
Any additional information, e.g.: address. | |
label |
string |
A displayable name of the own channel. |
{
"id": 0,
"type": "google_location",
"keywordId": 0,
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"channelId": "18120169027748581498",
"channelName": "Location#1",
"createdAt": 0,
"createdBy": 0,
"additionalInfo": "Budapest 1083, Bókay János utca 44-46",
"label": "Location#1"
}
Aspect Groups
Provides an interface to interact with the aspect group objects stored in our databases.
Listing aspect groups
GET /aspect-groups
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. | |
keywordGroupId omittable |
number |
Filter by a keyword group. |
{
"clientId": 0,
"profileId": 0,
"keywordGroupId": 0
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0&keywordGroupId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/aspect-groups?clientId=0&profileId=0&keywordGroupId=0
curl -G https://data.neticle.com/22.09/aspect-groups \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'\ -d 'keywordGroupId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/aspect-groups?clientId=0&profileId=0&keywordGroupId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/aspect-groups?clientId=0&profileId=0&keywordGroupId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/aspect-groups?clientId=0&profileId=0&keywordGroupId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/aspect-groups?clientId=0&profileId=0&keywordGroupId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Finding a single aspect group
GET /aspect-groups/:aspectId
curl -G https://data.neticle.com/22.09/aspect-groups/:aspectId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/aspect-groups/:aspectId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/aspect-groups/:aspectId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/aspect-groups/:aspectId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/aspect-groups/:aspectId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
AspectGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the aspect group | |
name |
string |
The internal name of the aspect group | |
label |
string |
The displayable name of the aspect group | |
keywordGroupId |
number |
The id of the keyword group this aspect groups belongs to. | |
profileId |
number |
The id of the profile this aspect group belongs to. | |
clientId |
number |
The id of the client this aspect group belongs to. | |
countryId |
number |
The id of the country this aspect group belongs to. | |
ianaTimeZone |
string |
The IANA time zone of the keyword group this aspect group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"name": "demaspg",
"label": "Demo aspect group",
"keywordGroupId": 0,
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Keyword Groups
Provides an interface to interact with the keyword group objects stored in our databases.
Listing keyword groups
GET /keyword-groups
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
If multiple constraints are given, only the most specific one is taken into consideration.
Constraints
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
clientId omittable |
number |
Filter by a client. | |
profileId omittable |
number |
Filter by a profile. |
{
"clientId": 0,
"profileId": 0
}
First, format the structure to an URL-encoded string:
clientId=0&profileId=0
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/keyword-groups?clientId=0&profileId=0
curl -G https://data.neticle.com/22.09/keyword-groups \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'clientId=0'\ -d 'profileId=0'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/keyword-groups?clientId=0&profileId=0', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/keyword-groups?clientId=0&profileId=0") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/keyword-groups?clientId=0&profileId=0" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/keyword-groups?clientId=0&profileId=0', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Finding a single keyword group
GET /keyword-groups/:keywordGroupId
curl -G https://data.neticle.com/22.09/keyword-groups/:keywordGroupId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/keyword-groups/:keywordGroupId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/keyword-groups/:keywordGroupId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/keyword-groups/:keywordGroupId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/keyword-groups/:keywordGroupId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
KeywordGroup |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the keyword group | |
label |
string |
A displayable name of the keyword group | |
profileId |
number |
The id of the profile this keyword group belongs to. | |
clientId |
number |
The id of the client this keyword group belongs to. | |
countryId |
number |
The id of the country this keyword group belongs to. | |
ianaTimeZone |
string |
The IANA time zone this keyword group belongs to. | |
ianaLanguages |
string[] |
The language codes the country uses, ordered by priority. |
{
"id": 0,
"label": "Demo keyword group",
"profileId": 0,
"clientId": 0,
"countryId": 0,
"ianaTimeZone": "Europe/Budapest",
"ianaLanguages": [
"hu"
]
}
Chart templates
Provides an interface to interact with the chart template objects stored in our databases.
Listing chart templates
GET /chart-templates
curl -G https://data.neticle.com/22.09/chart-templates \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/chart-templates', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/chart-templates") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/chart-templates" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/chart-templates', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate[] |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": [
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
],
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
Finding a single chart template
GET /chart-templates/:chartTemplateId
curl -G https://data.neticle.com/22.09/chart-templates/:chartTemplateId \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/chart-templates/:chartTemplateId', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/chart-templates/:chartTemplateId") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/chart-templates/:chartTemplateId" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/chart-templates/:chartTemplateId', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartTemplate |
The resource model(s). | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
Property | Type | Comment | |
---|---|---|---|
id |
number |
The identifier of the chart template. | |
name |
string |
An internal name for the chart's type. | |
title |
string |
The title of the chart template. | |
serviceGroup |
string |
- | |
description |
string |
The description of the template. | |
templateGroup |
string |
The template group this template belongs to. | |
highchartsType |
string |
The highcharts chart type of the template. | |
filters |
ViewFilter |
- | |
presentation |
ChartPresentation |
- |
{
"id": 0,
"name": "keyword_map",
"title": "Keyword map",
"serviceGroup": "shares",
"description": "",
"templateGroup": "Reputation and sentiment analysis",
"highchartsType": "scatter"
}
Referenced entities by ChartTemplate
Property | Type | Comment | |
---|---|---|---|
aspects |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources |
SourceGroup[] |
Filters between the content sources. | |
genders |
GenderGroup[] |
Filters for the gender of the author. | |
polarities |
PolarityGroup[] |
Filters for sentiment between the results. |
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end |
number |
The latest time in milliseconds. | |
start |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend |
boolean |
- | |
showTitle |
boolean |
- | |
showLegend |
boolean |
- | |
showAverage |
boolean |
- | |
numberOfValues |
number |
- | |
showTinyValues |
boolean |
- | |
showDescription |
boolean |
- | |
showTranslation |
ShowTranslation |
- | |
showInteractions |
boolean |
- | |
showChangeInValues |
boolean |
- | |
ianaTimeZone |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format |
ChartDataFormat |
- | |
ianaLanguage |
string |
The language of the descriptions |
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
Chart template data
Finding chart data by chart template
GET /chart-templates/:chartTemplateId/data
The API expects the following structure to be passed in the url parameters (query string), formatted as an url-encoded string.
ChartDataQuery
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
filters required |
ViewFilter |
A structure that influences the multiplicity of the results | |
presentation omittable |
ChartPresentation |
A structure that influences how your data will be presented. |
{
"filters": {
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
}
Referenced entities by ChartDataQuery
Property | Type | Comment | |
---|---|---|---|
aspects required |
string[] |
A list of aspect ids. Required only when "keywords" is not defined. | |
keywords required |
number[] |
A list of keyword ids. Required only when "aspects" is not defined. | |
interval omittable |
IntervalFilter |
The timestamps to search beween. Default:last 7 days (start: start of `current day - 7 days` day, end: end of the current day) |
|
sources omittable |
SourceGroup[] |
Filters between the content sources.
Default:
|
|
genders omittable |
GenderGroup[] |
Filters for the gender of the author.
Default:
|
|
polarities omittable |
PolarityGroup[] |
Filters for sentiment between the results.
Default:
|
{
"aspects": [
"10001_20002"
],
"keywords": [
10001,
10002
]
}
Referenced entities by ViewFilter
Property | Type | Comment | |
---|---|---|---|
end required |
number |
The latest time in milliseconds. | |
start required |
number |
The earliest time in milliseconds. |
{
"end": 1650978557230,
"start": 1649768957230
}
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
News | ||
3 |
Social media | ||
4 |
Offline sources | ||
5 |
Front page | ||
6 |
Forum | ||
7 |
Blog | ||
8 |
Comment | ||
9 |
Article | ||
10 |
Review | ||
11 |
Offline print | ||
12 |
Offline radio | ||
13 |
Offline tv | ||
14 |
|||
15 |
Google+ | ||
16 |
Video | ||
17 |
Tumblr | ||
18 |
|||
19 |
Twitter tweet | ||
20 |
Twitter reply | ||
21 |
Twitter retweet | ||
22 |
Twitter quoted | ||
23 |
Vk | ||
24 |
Vk comment | ||
25 |
|||
26 |
Tiktok | ||
27 |
Review classic | ||
28 |
Review Apple | ||
29 |
Review Play | ||
30 |
Review Huawei | ||
31 |
Facebook page post | ||
32 |
Facebook page comment | ||
33 |
Facebook page reply | ||
34 |
Instagram post | ||
35 |
Instagram comment | ||
36 |
Tiktok post | ||
37 |
Tiktok comment | ||
38 |
Other - Google+ | ||
39 |
Other - Pinterest | ||
40 |
Other - Tumblr | ||
41 |
Video - YouTube video | ||
42 |
Video - YouTube comment | ||
43 |
Facebook event post | ||
44 |
Facebook event comment | ||
45 |
Facebook group post | ||
46 |
Facebook group comment | ||
47 |
News aggregator | ||
48 |
Facebook group reply | ||
49 |
Facebook event reply |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
Only males. | ||
3 |
Only females. | ||
4 |
Only genders not identified as any previous variants. |
Value | Comment | ||
---|---|---|---|
1 |
No restriction, includes all following variants. | ||
2 |
All not negative | ||
3 |
All not neutral | ||
4 |
All not positive | ||
5 |
All extremes (only very positive or very negative) | ||
6 |
Positive | ||
7 |
Neutral | ||
8 |
Negative | ||
9 |
Only very positive | ||
10 |
Only very negative |
Property | Type | Comment | |
---|---|---|---|
showTrend omittable |
boolean |
-
Default:
|
|
showTitle omittable |
boolean |
-
Default:
|
|
showLegend omittable |
boolean |
-
Default:
|
|
showAverage omittable |
boolean |
-
Default:
|
|
numberOfValues omittable |
number |
-
Default:
|
|
showTinyValues omittable |
boolean |
-
Default:
|
|
showDescription omittable |
boolean |
-
Default:
|
|
showTranslation omittable |
ShowTranslation |
-
Default:
|
|
showInteractions omittable |
boolean |
-
Default:
|
|
showChangeInValues omittable |
boolean |
-
Default:
|
|
ianaTimeZone omittable |
string |
The time zone that should be applied to the stored data's creation time. Defaults to the profile of the first keyword/aspect filter. | |
format omittable |
ChartDataFormat |
-
Default:
|
|
ianaLanguage omittable |
string |
The language of the descriptions
Default:
|
{
"showTrend": false,
"showTitle": true,
"showLegend": true,
"showAverage": false,
"numberOfValues": 10,
"showTinyValues": true,
"showDescription": true,
"showTranslation": 0,
"showInteractions": true,
"showChangeInValues": false,
"ianaTimeZone": "Europe/Budapest",
"format": "highcharts",
"ianaLanguage": "en"
}
Referenced entities by ChartPresentation
First, format the structure to an URL-encoded string:
filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
Finally, append the string to the end of the endpoint, separated by a "?
" (question mark):
/chart-templates/:charttemplateid/data?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002
curl -G https://data.neticle.com/22.09/chart-templates/:chartTemplateId/data \ -H 'X-Requested-With: XMLHttpRequest' \ -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \ -d 'filters[aspects][0]=10001_20002'\ -d 'filters[keywords][0]=10001'\ -d 'filters[keywords][1]=10002'
const axios = require('axios'); const config = { method: 'get', url: 'https://data.neticle.com/22.09/chart-templates/:chartTemplateId/data?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', headers: { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });
Unirest.setTimeouts(0, 0); HttpResponse
response = Unirest.get("https://data.neticle.com/22.09/chart-templates/:chartTemplateId/data?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002") .header("X-Requested-With", "XMLHttpRequest") .header("Authorization", "Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6") .asString(); import requests url = "https://data.neticle.com/22.09/chart-templates/:chartTemplateId/data?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002" payload = {} headers = { 'Authorization': 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6', 'X-Requested-With': 'XMLHttpRequest' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
use GuzzleHttp\Psr7\Request; $client = new Client(); $headers = [ 'X-Requested-With' => 'XMLHttpRequest', 'Authorization' => 'Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' ]; $request = new Request('GET', 'https://data.neticle.com/22.09/chart-templates/:chartTemplateId/data?filters[aspects][0]=10001_20002&filters[keywords][0]=10001&filters[keywords][1]=10002', $headers ); $res = $client->sendAsync($request)->wait(); echo $res->getBody();
The API returns with the following structure in a JSON format.
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartData |
The chart aggregation object. It's format depends on the template, and the request's presentation settings. | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
This structure's shape may vary based on the chartTemplateId route parameter. The given example represents a sample response for a "freq" chart (chartTemplateId: 13), presented as a highcharts object. More details of the different chart types can be found at [highcharts.com].
Property | Type | Comment | |
---|---|---|---|
series |
SeriesOptions[] |
- | |
credits |
CreditsOptions |
- | |
chart |
ChartOptions |
- | |
title |
TitleOptions |
- | |
time |
TimeOptions |
- | |
plotOptions |
PlotOptions |
- | |
tooltip |
TooltipOptions |
- | |
legend |
LegendOptions |
- | |
caption |
CaptionOptions |
- | |
xAxis |
XAxisOptions |
- | |
yAxis |
YAxisOptions |
- |
{
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
}
Referenced entities by ChartData
Property | Type | Comment | |
---|---|---|---|
name |
string |
- | |
label |
string |
- | |
color |
string |
- | |
type |
string |
- | |
data |
PointOptions[] |
- |
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
Referenced entities by SeriesOptions
Example:
{
"enabled": false
}
Property | Type | Comment | |
---|---|---|---|
backgroundColor |
string |
- | |
style |
ChartStyleOptions |
- |
{
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by ChartOptions
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
useHTML |
boolean |
- | |
text |
string |
- | |
style |
TitleStyleOptions |
- |
{
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
}
Referenced entities by TitleOptions
Example:
{
"timezone": "Europe/Budapest"
}
Property | Type | Comment | |
---|---|---|---|
series |
SeriesPlotOptions |
- |
{
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
}
Referenced entities by PlotOptions
Property | Type | Comment | |
---|---|---|---|
cursor |
string |
- | |
marker |
MarkerOptions |
- |
{
"cursor": "pointer",
"marker": {
"enabled": false
}
}
Referenced entities by SeriesPlotOptions
Property | Type | Comment | |
---|---|---|---|
useHTML |
boolean |
- | |
shadow |
boolean |
- | |
followPointer |
boolean |
- | |
style |
TooltipStyleOptions |
- | |
headerFormat |
string |
- | |
pointFormat |
string |
- |
{
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
}
Referenced entities by TooltipOptions
Example:
{
"enabled": true,
"labelFormat": "{options.label}"
}
Example:
{
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by CaptionOptions
{
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
type |
string |
- | |
dateTimeLabelFormats |
DateTimeLabelFormatOptions |
- | |
labels |
AxisLabelOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
}
Referenced entities by XAxisOptions
Property | Type | Comment | |
---|---|---|---|
day |
string |
- | |
week |
string |
- | |
month |
string |
- | |
year |
string |
- |
{
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
Referenced entities by AxisLabelOptions
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
gridLineColor |
string |
- | |
labels |
AxisLabelOptions |
- | |
title |
YAxisTitleOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
Referenced entities by YAxisOptions
{
"text": null
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
Referenced entities by AxisLabelOptions
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartData |
The chart aggregation object. It's format depends on the template, and the request's presentation settings. | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
This structure's shape may vary based on the chartTemplateId route parameter. The given example represents a sample response for a "freq" chart (chartTemplateId: 13), presented as a highcharts object. More details of the different chart types can be found at [highcharts.com].
Property | Type | Comment | |
---|---|---|---|
series |
SeriesOptions[] |
- | |
credits |
CreditsOptions |
- | |
chart |
ChartOptions |
- | |
title |
TitleOptions |
- | |
time |
TimeOptions |
- | |
plotOptions |
PlotOptions |
- | |
tooltip |
TooltipOptions |
- | |
legend |
LegendOptions |
- | |
caption |
CaptionOptions |
- | |
xAxis |
XAxisOptions |
- | |
yAxis |
YAxisOptions |
- |
{
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
}
Referenced entities by ChartData
Property | Type | Comment | |
---|---|---|---|
name |
string |
- | |
label |
string |
- | |
color |
string |
- | |
type |
string |
- | |
data |
PointOptions[] |
- |
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
Referenced entities by SeriesOptions
Example:
{
"enabled": false
}
Property | Type | Comment | |
---|---|---|---|
backgroundColor |
string |
- | |
style |
ChartStyleOptions |
- |
{
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by ChartOptions
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
useHTML |
boolean |
- | |
text |
string |
- | |
style |
TitleStyleOptions |
- |
{
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
}
Referenced entities by TitleOptions
Example:
{
"timezone": "Europe/Budapest"
}
Property | Type | Comment | |
---|---|---|---|
series |
SeriesPlotOptions |
- |
{
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
}
Referenced entities by PlotOptions
Property | Type | Comment | |
---|---|---|---|
cursor |
string |
- | |
marker |
MarkerOptions |
- |
{
"cursor": "pointer",
"marker": {
"enabled": false
}
}
Referenced entities by SeriesPlotOptions
Property | Type | Comment | |
---|---|---|---|
useHTML |
boolean |
- | |
shadow |
boolean |
- | |
followPointer |
boolean |
- | |
style |
TooltipStyleOptions |
- | |
headerFormat |
string |
- | |
pointFormat |
string |
- |
{
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
}
Referenced entities by TooltipOptions
Example:
{
"enabled": true,
"labelFormat": "{options.label}"
}
Example:
{
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by CaptionOptions
{
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
type |
string |
- | |
dateTimeLabelFormats |
DateTimeLabelFormatOptions |
- | |
labels |
AxisLabelOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
}
Referenced entities by XAxisOptions
Property | Type | Comment | |
---|---|---|---|
day |
string |
- | |
week |
string |
- | |
month |
string |
- | |
year |
string |
- |
{
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
Referenced entities by AxisLabelOptions
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
gridLineColor |
string |
- | |
labels |
AxisLabelOptions |
- | |
title |
YAxisTitleOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
Referenced entities by YAxisOptions
{
"text": null
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
Referenced entities by AxisLabelOptions
ApiPayload
(struct)
|
|||
---|---|---|---|
Property | Type | Comment | |
data |
ChartData |
The chart aggregation object. It's format depends on the template, and the request's presentation settings. | |
meta |
null |
Any model/infromation related to the data. | |
error |
null |
Contains error information on unsuccessful requests. |
{
"data": {
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
},
"meta": null,
"error": null
}
Referenced entities by ApiPayload
This structure's shape may vary based on the chartTemplateId route parameter. The given example represents a sample response for a "freq" chart (chartTemplateId: 13), presented as a highcharts object. More details of the different chart types can be found at [highcharts.com].
Property | Type | Comment | |
---|---|---|---|
series |
SeriesOptions[] |
- | |
credits |
CreditsOptions |
- | |
chart |
ChartOptions |
- | |
title |
TitleOptions |
- | |
time |
TimeOptions |
- | |
plotOptions |
PlotOptions |
- | |
tooltip |
TooltipOptions |
- | |
legend |
LegendOptions |
- | |
caption |
CaptionOptions |
- | |
xAxis |
XAxisOptions |
- | |
yAxis |
YAxisOptions |
- |
{
"series": [
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
],
"credits": {
"enabled": false
},
"chart": {
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"title": {
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
},
"time": {
"timezone": "Europe/Budapest"
},
"plotOptions": {
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
},
"tooltip": {
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
},
"legend": {
"enabled": true,
"labelFormat": "{options.label}"
},
"caption": {
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
},
"xAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
},
"yAxis": {
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
}
Referenced entities by ChartData
Property | Type | Comment | |
---|---|---|---|
name |
string |
- | |
label |
string |
- | |
color |
string |
- | |
type |
string |
- | |
data |
PointOptions[] |
- |
{
"name": "Demo keyword",
"label": "Demo keyword (2140 pcs)",
"color": "#D5372C",
"type": "line",
"data": [
{
"y": 422,
"x": 1666216800000
},
{
"y": 327,
"x": 1666303200000
},
{
"y": 202,
"x": 1666389600000
},
{
"y": 174,
"x": 1666476000000
},
{
"y": 316,
"x": 1666562400000
},
{
"y": 323,
"x": 1666648800000
},
{
"y": 300,
"x": 1666735200000
},
{
"y": 76,
"x": 1666821600000
}
]
}
Referenced entities by SeriesOptions
Example:
{
"enabled": false
}
Property | Type | Comment | |
---|---|---|---|
backgroundColor |
string |
- | |
style |
ChartStyleOptions |
- |
{
"backgroundColor": "transparent",
"style": {
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by ChartOptions
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
useHTML |
boolean |
- | |
text |
string |
- | |
style |
TitleStyleOptions |
- |
{
"align": "left",
"useHTML": true,
"text": "Number of mentions (line)",
"style": {
"fontSize": "14px",
"fontWeight": "600"
}
}
Referenced entities by TitleOptions
Example:
{
"timezone": "Europe/Budapest"
}
Property | Type | Comment | |
---|---|---|---|
series |
SeriesPlotOptions |
- |
{
"series": {
"cursor": "pointer",
"marker": {
"enabled": false
}
}
}
Referenced entities by PlotOptions
Property | Type | Comment | |
---|---|---|---|
cursor |
string |
- | |
marker |
MarkerOptions |
- |
{
"cursor": "pointer",
"marker": {
"enabled": false
}
}
Referenced entities by SeriesPlotOptions
Property | Type | Comment | |
---|---|---|---|
useHTML |
boolean |
- | |
shadow |
boolean |
- | |
followPointer |
boolean |
- | |
style |
TooltipStyleOptions |
- | |
headerFormat |
string |
- | |
pointFormat |
string |
- |
{
"useHTML": true,
"shadow": false,
"followPointer": true,
"style": {
"fontSize": "12px",
"fontFamily": "Proxima-Nova, sans-serif",
"color": "#424454"
},
"headerFormat": "{point.x:%Y-%m-%d} - ",
"pointFormat": "Number of mentions: {point.y} pcs"
}
Referenced entities by TooltipOptions
Example:
{
"enabled": true,
"labelFormat": "{options.label}"
}
Example:
{
"text": "The Number of mentions chart shows the frequency of mentions according to a given keyword. The X-axis is time; the Y-axis is the number of mentions.",
"useHTML": true,
"style": {
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
}
Referenced entities by CaptionOptions
{
"fontSize": "12px",
"color": "#525E6D",
"paddingTop": "10px",
"paddingRight": "10px",
"borderTop": "1px solid #d8dce8",
"fontFamily": "Proxima-Nova, sans-serif"
}
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
type |
string |
- | |
dateTimeLabelFormats |
DateTimeLabelFormatOptions |
- | |
labels |
AxisLabelOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 0,
"type": "datetime",
"dateTimeLabelFormats": {
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
},
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
}
Referenced entities by XAxisOptions
Property | Type | Comment | |
---|---|---|---|
day |
string |
- | |
week |
string |
- | |
month |
string |
- | |
year |
string |
- |
{
"day": "%m.%d.",
"week": "%m.%d.",
"month": "%m.%d.",
"year": "%m.%d."
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}
Referenced entities by AxisLabelOptions
Property | Type | Comment | |
---|---|---|---|
lineWidth |
number |
- | |
tickWidth |
number |
- | |
startOnTick |
boolean |
- | |
endOnTick |
boolean |
- | |
gridLineWidth |
number |
- | |
gridLineColor |
string |
- | |
labels |
AxisLabelOptions |
- | |
title |
YAxisTitleOptions |
- |
{
"lineWidth": 0,
"tickWidth": 0,
"startOnTick": false,
"endOnTick": false,
"gridLineWidth": 1,
"gridLineColor": "#d8dce8",
"labels": {
"align": "center",
"style": {
"color": "#9fa7bc"
}
},
"title": {
"text": null
}
}
Referenced entities by YAxisOptions
{
"text": null
}
Property | Type | Comment | |
---|---|---|---|
align |
string |
- | |
style |
AxisLabelStyleOptions |
- |
{
"align": "center",
"style": {
"color": "#9fa7bc"
}
}