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
Use cases to be covered in upcoming releases:
  • 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:

  1. 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.

  2. Append a : (colon) character at the end:

    ExampleApiKey__lnREQII6yJjMZb4K4:
  3. Take the string you created in step 2, apply a Base64 encoding over it:

    RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6
    You should use a standard Base 64 encoder (for example .btoa() in JS), and not it's url-compatible variant!
  4. Take the result string from step 3 and prepend the string "Basic " at the start:

    Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6
  5. 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.03 Planning
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.
Depreciation policy

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

Content Copy icon
      curl -G https://data.neticle.com/22.09/clients \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "data": [
    {
      "id": 0,
      "name": "en_demo",
      "label": "Demo client",
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "name": "en_demo",
      "label": "Demo client",
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "name": "en_demo",
      "label": "Demo client",
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "id": 0,
  "name": "en_demo",
  "label": "Demo client",
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}


Finding a single client

Content Copy icon
      curl -G https://data.neticle.com/22.09/clients/:clientId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "data": {
    "id": 0,
    "name": "en_demo",
    "label": "Demo client",
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "name": "en_demo",
    "label": "Demo client",
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "name": "en_demo",
    "label": "Demo client",
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Client (struct)
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.
Example:
{
  "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

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.
Example:
{
  "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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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

Content Copy icon
      curl -G https://data.neticle.com/22.09/aspects/:aspectId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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.
Example:
{
  "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
Aspect (struct)
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
Example:
{
  "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

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.
Example:
{
  "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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "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

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:
{
  "currentPage": 1,
  "numberOfValues": 100,
  "includeResourceMap": false,
  "orderbBy": [
    {
      "by": 1,
      "direction": "asc"
    }
  ]
}
Example:
{
  "filters": {
    "aspects": [
      "10001_20002"
    ],
    "keywords": [
      10001,
      10002
    ]
  }
}
Referenced entities by View
ViewFilter (struct)
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:
[1]
genders
omittable
GenderGroup[]
Filters for the gender of the author.
Default:
[1]
polarities
omittable
PolarityGroup[]
Filters for sentiment between the results.
Default:
[1]
Example:
{
  "aspects": [
    "10001_20002"
  ],
  "keywords": [
    10001,
    10002
  ]
}
Referenced entities by ViewFilter
IntervalFilter (struct)
Property Type Comment
end
required
number
The latest time in milliseconds.
start
required
number
The earliest time in milliseconds.
Example:
{
  "end": 1650978557230,
  "start": 1649768957230
}

SourceGroup (enum)
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
Facebook
15
Google+
16
Video
17
Tumblr
18
Twitter
19
Twitter tweet
20
Twitter reply
21
Twitter retweet
22
Twitter quoted
23
Vk
24
Vk comment
25
Instagram
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

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.

PolarityGroup (enum)
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


Presentation (struct)
Property Type Comment
currentPage
omittable
number
Controls from which page the result set will be returned
Default:
1
numberOfValues
omittable
number
The number of mentions per page
Default:
100
orderBy
omittable
OrderBy[]
Controls the order of the result set
Default:
[{"by":1,"direction":"asc"}]
includeResourceMap
omittable
boolean
Toggles whether the response should include a lookup map for all the resource IDs as a meta object.
Default:
false
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.
Example:
{
  "currentPage": 1,
  "numberOfValues": 100,
  "orderBy": [
    {
      "by": 1,
      "direction": "asc"
    }
  ],
  "includeResourceMap": false,
  "ianaTimeZone": "Europe/Budapest"
}
Referenced entities by Presentation
OrderBy (struct)
Property Type Comment
id
required
NumericProperty
The identifier of the property to order by
order
required
OrderDirection
The direction of the order
Example:
{
  "id": 1,
  "order": "desc"
}
Referenced entities by OrderBy
OrderDirection (enum)
Value Comment
asc
Ascending
desc
Descending

NumericProperty (enum)
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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
    }
  ],
  "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
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


MentionMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the mentions
relatedResources
null | RelatedResourceMap
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap)
Example:
{
  "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
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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.
Example:
{
  "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
    }
  ],
  "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
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


MentionMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the mentions
relatedResources
null | RelatedResourceMap
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap)
Example:
{
  "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
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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.
Example:
{
  "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
    }
  ],
  "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
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


MentionMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the mentions
relatedResources
null | RelatedResourceMap
Shows the resources that appeared in the mentions (controlled by presentation.includeResourceMap)
Example:
{
  "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
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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

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.
Example:
{
  "presentation": {
    "includeResourceMap": false
  }
}
Referenced entities by PartialPresentation
RelatedResourcesPresentation (struct)
Property Type Comment
includeResourceMap
omittable
boolean
Toggles whether the response should include a lookup map for all the resource IDs as a meta object.
Default:
false
Example:
{
  "includeResourceMap": false
}


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
Content Copy icon
      curl -G https://data.neticle.com/22.09/mentions/:mentionId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \
    -d 'presentation[includeResourceMap]=false'
  
      
      
      
      

    

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.
Example:
{
  "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
  },
  "meta": {
    "relatedResources": null
  },
  "error": null
}
Referenced entities by ApiPayload
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


SingleMentionMeta (struct)
Property Type Comment
relatedResources
RelatedResourceMap
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap)
Example:
{
  "relatedResources": null
}
Referenced entities by SingleMentionMeta
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
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.
Example:
{
  "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
  },
  "meta": {
    "relatedResources": null
  },
  "error": null
}
Referenced entities by ApiPayload
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


SingleMentionMeta (struct)
Property Type Comment
relatedResources
RelatedResourceMap
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap)
Example:
{
  "relatedResources": null
}
Referenced entities by SingleMentionMeta
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
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.
Example:
{
  "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
  },
  "meta": {
    "relatedResources": null
  },
  "error": null
}
Referenced entities by ApiPayload
Mention (struct)
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.
Example:
{
  "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
}
Referenced entities by Mention
FacebookDetails (struct)
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.
Example:
{
  "angry": 0,
  "care": 0,
  "haha": 0,
  "love": 0,
  "sad": 0,
  "wow": 0,
  "fan": 0,
  "like": 0,
  "share": 0,
  "reply": 0,
  "comment": 0
}

InstagramDetails (struct)
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.
Example:
{
  "like": 0,
  "view": 0,
  "score": 0,
  "comment": 0,
  "follower": 0
}

TwitterDetails (struct)
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.
Example:
{
  "like": 0,
  "comment": 0,
  "retweet": 0,
  "follower": 0
}

YouTubeDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "dislike": 0,
  "comment": 0,
  "subscribe": 0
}

TiktokDetails (struct)
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.
Example:
{
  "view": 0,
  "like": 0,
  "share": 0,
  "follower": 0
}

ReviewDetails (struct)
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.
Example:
{
  "upvote": 0,
  "downvote": 2,
  "starRatingMax": null,
  "starRatingScore": null,
  "starRatingVersion": null
}

GenderGroup (enum)
Value Comment
1
No restriction, includes all following variants.
2
Only males.
3
Only females.
4
Only genders not identified as any previous variants.


SingleMentionMeta (struct)
Property Type Comment
relatedResources
RelatedResourceMap
Shows the resources that appeared in the mention (controlled by presentation.includeResourceMap)
Example:
{
  "relatedResources": null
}
Referenced entities by SingleMentionMeta
RelatedResourceMap (struct)
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
Example:
{
  "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
GenderRecord (struct)
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
Example:
{
  "id": 2,
  "name": "male",
  "label": "Male"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

OwnChannel (struct)
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.
Example:
{
  "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"
}

ByLabelTypes (struct)
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
Example:
{
  "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
Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}


Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Language (struct)
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
Example:
{
  "id": 0,
  "label": "Ukrainian",
  "isoCode2": "uk",
  "neticleCode": "ua"
}

City (struct)
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
Example:
{
  "id": 0,
  "label": "Budapest",
  "countryId": 1
}

Region (struct)
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
Example:
{
  "id": 0,
  "label": "Pest",
  "countryId": 1
}

Label (struct)
Property Type Comment
id
number
The identifier of the label
label
string
The label
Example:
{
  "id": 0,
  "label": "demo label"
}




Keywords

Provides an interface to interact with the keyword objects stored in our databases.

Listing 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.
Example:
{
  "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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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

Content Copy icon
      curl -G https://data.neticle.com/22.09/keywords/:keywordId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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.
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "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

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.
Example:
{
  "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
Content Copy icon
      curl -G https://data.neticle.com/22.09/profiles \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' \
    -d 'clientId=0'
  
      
      
      
      

    

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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "Demo profile",
      "clientId": 0,
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "Demo profile",
      "clientId": 0,
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "Demo profile",
      "clientId": 0,
      "countryId": 0,
      "ianaTimeZone": "Europe/Budapest",
      "ianaLanguages": [
        "hu"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo profile",
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}


Finding a single profile

Content Copy icon
      curl -G https://data.neticle.com/22.09/profiles/:profileId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "data": {
    "id": 0,
    "label": "Demo profile",
    "clientId": 0,
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "label": "Demo profile",
    "clientId": 0,
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "label": "Demo profile",
    "clientId": 0,
    "countryId": 0,
    "ianaTimeZone": "Europe/Budapest",
    "ianaLanguages": [
      "hu"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Profile (struct)
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.
Example:
{
  "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

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:
{
  "currentPage": 1,
  "numberOfValues": 100,
  "includeResourceMap": false
}
Example:
{
  "filters": {
    "aspects": [
      "10001_20002"
    ],
    "keywords": [
      10001,
      10002
    ],
    "interval": {
      "end": 1650978557230,
      "start": 1649768957230
    }
  }
}
Referenced entities by InsightView
InsightViewFilter (struct)
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.
Example:
{
  "aspects": [
    "10001_20002"
  ],
  "keywords": [
    10001,
    10002
  ],
  "interval": {
    "end": 1650978557230,
    "start": 1649768957230
  }
}
Referenced entities by InsightViewFilter
IntervalFilter (struct)
Property Type Comment
end
required
number
The latest time in milliseconds.
start
required
number
The earliest time in milliseconds.
Example:
{
  "end": 1650978557230,
  "start": 1649768957230
}

SourceGroup (enum)
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
Facebook
15
Google+
16
Video
17
Tumblr
18
Twitter
19
Twitter tweet
20
Twitter reply
21
Twitter retweet
22
Twitter quoted
23
Vk
24
Vk comment
25
Instagram
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


InsightPresentation (struct)
Property Type Comment
currentPage
omittable
number
Controls from which page the result set will be returned
Default:
1
numberOfValues
omittable
number
The number of mentions per page
Default:
100
includeResourceMap
omittable
boolean
Toggles whether the response should include a lookup map for all the resource IDs as a meta object.
Default:
false
Example:
{
  "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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
Insight (struct)
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
-
Example:
{
  "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
InsightDescription (struct)
Property Type Comment
title
string
The title of the insight.
text
string
The text of the insight.
Example:
{
  "title": "Title of the insight",
  "text": "Text of the insight"
}


InsightsMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the insights
relatedResources
InsightsRelatedResourceMap
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap)
Example:
{
  "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
InsightsRelatedResourceMap (struct)
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
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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.
Example:
{
  "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
Insight (struct)
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
-
Example:
{
  "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
InsightDescription (struct)
Property Type Comment
title
string
The title of the insight.
text
string
The text of the insight.
Example:
{
  "title": "Title of the insight",
  "text": "Text of the insight"
}


InsightsMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the insights
relatedResources
InsightsRelatedResourceMap
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap)
Example:
{
  "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
InsightsRelatedResourceMap (struct)
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
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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.
Example:
{
  "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
Insight (struct)
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
-
Example:
{
  "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
InsightDescription (struct)
Property Type Comment
title
string
The title of the insight.
text
string
The text of the insight.
Example:
{
  "title": "Title of the insight",
  "text": "Text of the insight"
}


InsightsMeta (struct)
Property Type Comment
pagination
Pagination
Pagination for the insights
relatedResources
InsightsRelatedResourceMap
Shows the resources that appeared in the insights (controlled by presentation.includeResourceMap)
Example:
{
  "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
InsightsRelatedResourceMap (struct)
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
Example:
{
  "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
Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Aspect (struct)
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
Example:
{
  "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"
}

Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}


Pagination (struct)
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
Example:
{
  "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
QueryParams (struct)
Property Type Comment
lastPage
string
-
nextPage
string
-
firstPage
string
-
previousPage
string
-
Example:
{
  "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

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.
Example:
{
  "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
Content Copy icon
      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'
  
      
      
      
      

    

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.
Example:
{
  "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
Resources (struct)
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
Example:
{
  "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
Client (struct)
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.
Example:
{
  "id": 0,
  "name": "en_demo",
  "label": "Demo client",
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

Aspect (struct)
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
Example:
{
  "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"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Profile (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo profile",
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

AspectGroup (struct)
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.
Example:
{
  "id": 0,
  "name": "demaspg",
  "label": "Demo aspect group",
  "keywordGroupId": 0,
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

KeywordGroup (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo keyword group",
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}


ResourcesMeta (struct)
Property Type Comment
relatedResources
null | RelatedResourceMap
When enabled, contains lookup maps to referenced resource models.
Example:
{
  "relatedResources": null
}
Referenced entities by ResourcesMeta
RelatedResourceMap (struct)
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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Country (struct)
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.
Example:
{
  "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.
Example:
{
  "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
Resources (struct)
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
Example:
{
  "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
Client (struct)
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.
Example:
{
  "id": 0,
  "name": "en_demo",
  "label": "Demo client",
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

Aspect (struct)
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
Example:
{
  "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"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Profile (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo profile",
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

AspectGroup (struct)
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.
Example:
{
  "id": 0,
  "name": "demaspg",
  "label": "Demo aspect group",
  "keywordGroupId": 0,
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

KeywordGroup (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo keyword group",
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}


ResourcesMeta (struct)
Property Type Comment
relatedResources
null | RelatedResourceMap
When enabled, contains lookup maps to referenced resource models.
Example:
{
  "relatedResources": null
}
Referenced entities by ResourcesMeta
RelatedResourceMap (struct)
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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Country (struct)
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.
Example:
{
  "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.
Example:
{
  "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
Resources (struct)
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
Example:
{
  "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
Client (struct)
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.
Example:
{
  "id": 0,
  "name": "en_demo",
  "label": "Demo client",
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

Aspect (struct)
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
Example:
{
  "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"
}

Keyword (struct)
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
Example:
{
  "id": 0,
  "name": "demokeyw",
  "label": "Demo keyword",
  "profileId": 0,
  "keywordGroupId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ],
  "sourceIds": [],
  "color": "#0099FF"
}

Profile (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo profile",
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

AspectGroup (struct)
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.
Example:
{
  "id": 0,
  "name": "demaspg",
  "label": "Demo aspect group",
  "keywordGroupId": 0,
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}

KeywordGroup (struct)
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.
Example:
{
  "id": 0,
  "label": "Demo keyword group",
  "profileId": 0,
  "clientId": 0,
  "countryId": 0,
  "ianaTimeZone": "Europe/Budapest",
  "ianaLanguages": [
    "hu"
  ]
}


ResourcesMeta (struct)
Property Type Comment
relatedResources
null | RelatedResourceMap
When enabled, contains lookup maps to referenced resource models.
Example:
{
  "relatedResources": null
}
Referenced entities by ResourcesMeta
RelatedResourceMap (struct)
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.
Example:
{
  "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
Source (struct)
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.
Example:
{
  "id": 6,
  "name": "forum",
  "order": 5,
  "color": "#9F20C1",
  "isGroup": 1,
  "isEnabled": 1,
  "sourceCode": 2,
  "parentSourceId": null
}

Country (struct)
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.
Example:
{
  "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

Content Copy icon
      curl -G https://data.neticle.com/22.09/countries \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "United Kingdom",
      "isoCode2": "gb",
      "neticleCode": "uk",
      "ianaTimeZone": "Europe/London",
      "ianaLanguages": [
        "en"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "United Kingdom",
      "isoCode2": "gb",
      "neticleCode": "uk",
      "ianaTimeZone": "Europe/London",
      "ianaLanguages": [
        "en"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "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.
Example:
{
  "data": [
    {
      "id": 0,
      "label": "United Kingdom",
      "isoCode2": "gb",
      "neticleCode": "uk",
      "ianaTimeZone": "Europe/London",
      "ianaLanguages": [
        "en"
      ]
    }
  ],
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "id": 0,
  "label": "United Kingdom",
  "isoCode2": "gb",
  "neticleCode": "uk",
  "ianaTimeZone": "Europe/London",
  "ianaLanguages": [
    "en"
  ]
}


Finding a single country

Content Copy icon
      curl -G https://data.neticle.com/22.09/countries/:countryId \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Basic RXhhbXBsZUFwaUtleV9fbG5SRVFJSTZ5SmpNWmI0SzQ6' 
  
      
      
      
      

    

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.
Example:
{
  "data": {
    "id": 0,
    "label": "United Kingdom",
    "isoCode2": "gb",
    "neticleCode": "uk",
    "ianaTimeZone": "Europe/London",
    "ianaLanguages": [
      "en"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "label": "United Kingdom",
    "isoCode2": "gb",
    "neticleCode": "uk",
    "ianaTimeZone": "Europe/London",
    "ianaLanguages": [
      "en"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "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.
Example:
{
  "data": {
    "id": 0,
    "label": "United Kingdom",
    "isoCode2": "gb",
    "neticleCode": "uk",
    "ianaTimeZone": "Europe/London",
    "ianaLanguages": [
      "en"
    ]
  },
  "meta": null,
  "error": null
}
Referenced entities by ApiPayload
Country (struct)
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.
Example:
{
  "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

Restricted endpoint - authorization needed
 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.
Example:
{
  "filters": {
    "aspects": [
      "10001_20002"
    ],
    "keywords": [
      10001,
      10002
    ]
  }
}
Referenced entities by Filters
ViewFilter (struct)
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