Skip to main content

Where Can I Check the Detailed Technical API Documentation?

Updated over a month ago

If you are planning to build or maintain an integration with the BrandMentions API, you will often need a single, reliable place to check all available endpoints, parameters, and examples.

What you will find in the API documentation

On that page you will find:

  • Authentication details
    How to use your API key and structure requests.
    ​

  • Endpoint reference
    All available commands (such as PostSearch, GetMentions, GetProjectMentions, GetProjectInfluencers, GetRemainingCredits, and more), including:

    • Required and optional parameters

    • Request examples

    • Response formats
      ​

  • Error codes and messages
    A complete list of API error codes, what they mean, and how to handle them.
    ​

  • Usage limits and credits
    Information about API limits, credits, and how different commands consume them.
    ​

  • Additional notes and examples
    Helpful details on filtering, time ranges, pagination, historical data, and callback usage.

How to use the documentation effectively

  • Bookmark the URL so your team can always access the latest version.

  • Start with authentication and basic examples, then move into specific endpoints for your use case.

  • Cross reference error codes in your logs with the list in the docs when debugging.

  • Check parameters and examples whenever you see unexpected responses from the API.

Did this answer your question?