Repository files navigation

Below you will the documentation forSocialmetrix Echo API.Any doubt or suggestion you cancontact us directly.

In order to access our API you need to get your credentials consisting of an username and a token, please refer to your account executive to obtain them. They will be like this:

Username: arjonesToken: e621ef33-62b0-4a44-9c9c-559f40b546cb

Our current API uses yourEcho Instance asbase url , your instance is defined at your URL, for example, if your url is:http://socialmetrix-lat.smxecho.com/ your instance issocialmetrix-lat.

Once you have the instance, you can setup the base url as follows:http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo

Once you have your credentials you MUST include them as part of HTTP HEADER.As an example, usingcurl:

INSTANCE=socialmetrix-latSMXUSER=arjonesTOKEN=e621ef33-62b0-4a44-9c9c-559f40b546cbcurl \  -H"username:$SMXUSER" \  -H"token:$TOKEN" \  -H'Content-Type: application/json' \"http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo/options/brands"

During this initial phase, the API isn't rate limited, we want to learn from our customers' consumption patterns to provide an easy to use API. Keep in mind that misuse or abuse will be blocked.

Currently available endpoints are:

• /options/brands: Provides information about thebrands metadata.
• /reputation/brands: Provides information about thebrand reputation.
• /sparkline/brands/mentions: Provides information about thebrand's mentions.
• /sparkline/brands/authors: Provides information about thebrand's authors.
• /sparkline/brands/sources: Provides information about thebrand's sources.

Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please use GitHub issues. Fork these docs and send a pull request with improvements.