API - Mentions
API gateway
https://app.mentionmind.com/api/mention.php?token=%token%&func=%function%
Required GET fields
token - Your API session token. Learn how to log in and obtain your session token
func - The API function you wish to call
For guidance on how to use the Mentionmind API, refer to our API usage example article
Endpoints
1. getMentions
get project mentions
Endpoint
https://app.mentionmind.com/api/mention.php?func=getMentions
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (GET) sort (string, optional): Possible values - "favorites", "web", "reddit", "linkedin", default "date"
- (GET) order (optional): ASC or DESC, default ASC
- (GET) start (int, optional): line to start from, default 0
- (GET) limit (int, optional): lines in the report, default 50
2. getRecommendations
edit available AI recommendations
Endpoint
https://app.mentionmind.com/api/mention.php?func=getRecommendations
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
3. getTotalMentions
Get the total mentions
Endpoint
https://app.mentionmind.com/api/mention.php?func=getTotalMentions
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
4. getCurrentPeriodTotalMentions
Get account usage statistics – how many new mentions were found during the current billing period
Endpoint
https://app.mentionmind.com/api/mention.php?func=getCurrentPeriodTotalMentions
Parameters
- (GET) token (int, required): Your API session token.
5. removeMention
Delete mention
Endpoint
https://app.mentionmind.com/api/mention.php?func=removeMention
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) mention_id (int, required): Mention ID
6. removeAllMentions
Delete all mentions
Endpoint
https://app.mentionmind.com/api/mention.php?func=removeAllMentions
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
7. removeRecommendation
Delete recommendation
Endpoint
https://app.mentionmind.com/api/mention.php?func=removeRecommendation
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) recommendation_id (int, required): Recommendation ID
8. addToFavorites
Add the mention to Favorites
Endpoint
https://app.mentionmind.com/api/mention.php?func=addToFavorites
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) mention_id (int, required): Mention ID
9. removeFromFavorites
Delete the mention from Favorites
Endpoint
https://app.mentionmind.com/api/mention.php?func=removeFromFavorites
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) mention_id (int, required): Mention ID
10. getSummary
Get remote webpage summary
Endpoint
https://app.mentionmind.com/api/mention.php?func=getSummary
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) mention_id (int, required): Mention ID
11. getSocialShares
Display analytics on social media activity data for remote webpages
Endpoint
https://app.mentionmind.com/api/mention.php?func=getSocialShares
Parameters
- (GET) token (int, required): Your API session token.
- (POST) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (POST) mention_id (int, required): Mention ID