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

Delete mention

Endpoint 

https://app.mentionmind.com/api/mention.php?func=removeMention

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) mention_id (int, required): Mention ID


5. removeAllMentions

Delete all mentions

Endpoint 

https://app.mentionmind.com/api/mention.php?func=removeAllMentions

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)


6. removeRecommendation

Delete recommendation

Endpoint 

https://app.mentionmind.com/api/mention.php?func=removeRecommendation

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) recommendation_id (int, required): Recommendation ID


7. 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.
  • (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) mention_id (int, required): Mention ID


8. 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.
  • (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) mention_id (int, required): Mention ID


9. getSummary

Get remote webpage summary

Endpoint 

https://app.mentionmind.com/api/mention.php?func=getSummary

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) url (string, required): Remote page URL