Connected Keywords
This endpoint is great to understand how a keyword connects to other keywords. To understand what other keywords are mentioned the most for a specific keyword and to see if anything is trending. As an example you could look at the keyword AWS and see the top and trending connect keywords for a period. You can also extract the sources to do analysis.
Connected Endpoint
To use this endpoint you'll have to consider the period you want to query, the default is set to weekly, along with what keyword(s) you want to find connecting keywords for. You have the option to get back slim results and then expanded results. Expanded results will give you back source ids that you can look up to get the exact sources.
Properties
- Name
period- Type
- string (required)
- Description
The period you are looking to get keyword data for. Periods available are daily, weekly, monthly, quarterly and yearly.
- Name
slim- Type
- bool (required)
- Description
This property is by default set to true, if set to false it will show you exact sentiment numbers along with source ids. To get the links and texts from the sources, see » Sources Endpoint
- Name
keyword- Type
- string (required)
- Description
Set the keyword you want to find connecting keywords for. You may use & or || to set several keywords. Example is AWS, AWS||S3, AWS&S3.
Public v2
This endpoint allows you to get back the connected keywords for a keyword during a specific period.
Required attributes
- Name
period- Type
- string
- Description
Set the period to daily, weekly or monthly. The period will look at the preceeding period to calculate differences in statistics.
- Name
slim- Type
- bool
- Description
This property is by default set to true, if set to false it will show you exact sentiment numbers along with source ids.
- Name
keyword- Type
- string
- Description
Set the keyword you want to find connecting keywords for. You may use & or || to set several keywords. Example is AWS, AWS||S3, AWS&S3.
Optional attributes
- Name
sort- Type
- string
- Description
Sort is set as trending by default. You may set it as top or trending.
- Name
limit- Type
- integer
- Description
Limit is set to 40 keywords by default, you may expand this to up to 2000.
- Name
category- Type
- string
- Description
Keywords can fall under different categories. If you want to specify the keyword queried under a specific category use this property. Understand Categories » Q&A
- Name
type- Type
- string
- Description
Set the type of mentions counted by only post (post, article, newsletter and so on) or comment.
- Name
source- Type
- bool
- Description
Set the specific source you want the data to orginate from. Some choices are hackernews, reddit, devto and github and so on.
- Name
sentiment- Type
- string
- Description
Only get back the keywords with a majority sentiment that is specified as neutral, positive or negative. Remember that you can expand the results to get the count of each sentiment using slim=false parameter instead if you want to see the count for each sentiment per keyword instead.
- Name
minMentions- Type
- integer
- Description
Only return results if a keyword has been mentioned a specified amount of times. Default is set at 10.
- Name
authority- Type
- integer
- Description
Every mention is set with an engagement number, a keyword may be spammed if the keyword has a low authority score. Default is set at 1 but you may increase or decrease it.
- Name
search- Type
- string
- Description
Instead of the keywords field you may use search, this one will search more documents in the text field rather than use the keywords field.
Request
curl -G https://public.api.safron.io/v2/connected-keywords \
-d period=weekly \
-d keyword=AWS \
-d slim=true
Response
{
"period_chosen": "weekly",
"keyword_to_connect": "AWS",
"documents_found": 845,
"sorted": "trending",
"limit": 40,
"data_updated": "2024-08-12",
"slim_results": true,
"keywords": [
{
"keyword": "Microsoft Azure",
"category": "Platforms & Search Engines",
"trending": true,
"count": 33,
"count_change": 153.84615384615387,
"engagement": 2371,
"engagement_change": 1286.5204678362575,
"sentiment": "neutral",
"change_in_sentiment": false
},
{
"keyword": "Terraform",
"category": "Tools & Services",
"trending": true,
"count": 29,
"count_change": 31.818181818181817,
"engagement": 890,
"engagement_change": 324.1624423524031,
"sentiment": "neutral",
"change_in_sentiment": false
},
// ...
]
}
Rate limits apply to all public endpoints. See » Q&A.
Private v2
This private endpoint allows you to get back the connected keywords for a keyword during a specific period. There are no usage limits to this endpoint and you can query data up to a year back in time.
Required attributes
- Name
period- Type
- string
- Description
Set the period to daily, weekly or monthly. The period will look at the preceeding period to calculate differences in statistics.
- Name
slim- Type
- bool
- Description
This property is by default set to true, if set to false it will show you exact sentiment numbers along with source ids.
- Name
keyword- Type
- string
- Description
Set the keyword you want to find connecting keywords for. You may use & or || to set several keywords. Example is AWS, AWS||S3, AWS&S3.
Optional attributes
- Name
sort- Type
- string
- Description
Sort is set as trending by default. You may set it as top or trending.
- Name
limit- Type
- integer
- Description
Limit is set to 40 keywords by default, you may expand this to up to 2000.
- Name
category- Type
- string
- Description
Keywords can fall under different categories. If you want to specify the keyword queried under a specific category use this property. Understand Categories » Q&A
- Name
type- Type
- string
- Description
Set the type of mentions counted by only post (post, article, newsletter and so on) or comment.
- Name
source- Type
- bool
- Description
Set the specific source you want the data to orginate from. Some choices are hackernews, reddit, devto and github and so on.
- Name
sentiment- Type
- string
- Description
Only get back the keywords with a majority sentiment that is specified as neutral, positive or negative. Remember that you can expand the results to get the count of each sentiment using slim=false parameter instead if you want to see the count for each sentiment per keyword instead.
- Name
minMentions- Type
- integer
- Description
Only return results if a keyword has been mentioned a specified amount of times. Default is set at 10.
- Name
authority- Type
- integer
- Description
Every mention is set with an engagement number, a keyword may be spammed if the keyword has a low authority score. Default is set at 1 but you may increase or decrease it.
- Name
search- Type
- string
- Description
Instead of the keywords field you may use search, this one will search more documents in the text field rather than use the keywords field.
Request
curl -G https://private.api.safron.io/v2/connected-keywords \
-H x-api-key: {API_Key} \
-d period=weekly \
-d keyword=AWS \
-d slim=true
Response
{
"period_chosen": "weekly",
"keyword_to_connect": "AWS",
"documents_found": 845,
"sorted": "trending",
"limit": 40,
"data_updated": "2024-08-12",
"slim_results": true,
"keywords": [
{
"keyword": "Microsoft Azure",
"category": "Platforms & Search Engines",
"trending": true,
"count": 33,
"count_change": 153.84615384615387,
"engagement": 2371,
"engagement_change": 1286.5204678362575,
"sentiment": "neutral",
"change_in_sentiment": false
},
{
"keyword": "Terraform",
"category": "Tools & Services",
"trending": true,
"count": 29,
"count_change": 31.818181818181817,
"engagement": 890,
"engagement_change": 324.1624423524031,
"sentiment": "neutral",
"change_in_sentiment": false
},
// ...
]
}