Understanding and Using the Mention API
The Mention API is a powerful tool designed to allow users to access and manage their Mention data programmatically. This article provides an overview of the API, its uses, and its limitations, helping you integrate Mention's capabilities into your own applications and workflows.
What is an API?
API stands for Application Programming Interface. It connects different software systems, allowing them to communicate. In the context of Mention, the API connects Mention's backend servers with web and mobile applications, enabling operations such as fetching and modifying data.
The Mention API
The Mention API is a JSON based, RESTful API designed to give developers access to Mention's features and data. You can use the API to integrate Mention into your own website or application, customize the layout, and manage rights. It also allows for intelligent crawling, with the output feeding into your own workflow or system.
Key Operations:
Alerts: List, create, update, delete, pause, unpause, and share alerts.
Mentions: List, access, stream, and curate mentions. You can also mark mentions as read.
For detailed documentation, refer to Mention API Documentation.
API Uses
Data Integration: Incorporate Mention data into your own systems.
Custom Applications: Build custom applications with Mention's data.
Real-time Streaming: Use the streaming API to receive mentions in real-time.
API Limitations
The Mention API is subject to the same quotas and features as the Mention account:
Alert Creation: Limited to the account's allowed number of alerts.
Rate Limits:
Create alert:
max(20, alertsQuota*2)calls per 24 hours.List mentions: 3600 calls per alert per 24 hours.
Source-specific Restrictions:
Twitter, Tiktok, LinkedIN, and Instagram: The metadata provided for these sources may require additional configuration due to legal restrictions. Be sure to check out our guides on retrieving metadata here.
Historical Data: Cannot be enabled via the API. However, it's absolutely possible to fetch mentions from the past using Historical Data through our web app!
Content Snippets: Only up to 250 characters of the most relevant parts of the mention are returned.
For more details on source-specific restrictions, refer to Mention API Source Restrictions.
Examples and FAQs
What can I do with the API?
Access a Mention account and perform actions allowed by that account.
Create and manage alerts.
Stream mentions in real-time.
Is the full article/post content returned by the API?
No, due to legal and intellectual property reasons, the API returns only a snippet of up to 250 characters of the most relevant part of the mention.
Can I enable historical data on an alert with the API?
No, enabling historical data on an alert is not possible with the API.
Conclusion
The Mention API is a versatile tool that allows you to harness the power of Mention's data and features in your own applications and workflows. By understanding its capabilities and limitations, you can make the most of this powerful integration tool. For comprehensive documentation, always refer to Mention API Documentation.
This service has an extra cost.