API

Programmatic access to your Symmetrics data.

Our APIs allows developers to query the data and metrics you’ve collected, much like from within widgets, but with full freedom of appliance.

Click here to retrieve your Symmetrics user ID and manage authentication keys. Be sure to utilize the query console to quickly prototype your queries.

Pro-tip: You can also use our client package on npm to interface to our APIs.

Authenticating

Having retrieved your Symmetrics user ID and created an authentication key, you’re ready to connect to the APIs and start running queries on the data.

Example

https://getsymmetrics.com/api/v1/events?user-id={{YOUR_USER_ID}}&authentication-key={{YOUR_AUTHENTICATION_KEY}}&query=count

Simply replace {{YOUR_USER_ID}} and {{YOUR_AUTHENTICATION_KEY}} respectively, and you should have a functional request.

user-id
Your Symmetrics user ID.

authentication-key
Your Symmetrics authentication key.

GET /v1/events

Returns results with the outcome of your JsonQl query.

Example

https://getsymmetrics.com/api/v1/events?user-id={{YOUR_USER_ID}}&authentication-key={{YOUR_AUTHENTICATION_KEY}}&query=count&timezone-offset=-12

query (optional)
URL encoded JsonQl query string.Example: count

timezone-offset (optional)
Client timezone offset in minutes divided by 10, and then rounded.Example: -12 (client is 2 hours ahead [GMT+2])

GET /v1/apps/tweets/data

Returns results with a list of tweets about your websites.

Example

https://getsymmetrics.com/api/v1/apps/tweets/data?user-id={{YOUR_USER_ID}}&authentication-key={{YOUR_AUTHENTICATION_KEY}}

start-timestamp (optional)
Start of search timestamp (in milliseconds).Example: 1600103109877

end-timestamp (optional)
End of search timestamp (in milliseconds).Example: 1600103109879