{"id":526,"date":"2017-01-24T08:47:54","date_gmt":"2017-01-24T08:47:54","guid":{"rendered":"https:\/\/www.rivaliq.com\/?page_id=526"},"modified":"2024-04-16T22:42:38","modified_gmt":"2024-04-16T22:42:38","slug":"developers","status":"publish","type":"page","link":"https:\/\/www.rivaliq.com\/developers\/","title":{"rendered":"Developers"},"content":{"rendered":"

The Rival IQ API<\/span><\/h1>

An easy way to integrate the Rival IQ data you need into your existing systems.<\/p>\n<\/div><\/div><\/div><\/div>

Introduction<\/span><\/h2>

The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app. This feature is only available on certain plans. Talk to our support team<\/a> for more information.<\/p>\n<\/div>Read the API Reference<\/a><\/div><\/div><\/div>

API Overview<\/span><\/h2>

Here, you’ll find additional details about data, authentication, and rate limits.<\/p>\n<\/div><\/div><\/div><\/div>

Data Model<\/span><\/h3>

The API allows you to retrieve social data, including individual posts, daily metric summaries, period metric summaries, and social presence positioning copy. The API also provides management features for creating and managing landscapes in your account.<\/p>\n

Data is organized using the same groupings as in the app. Data is accessed one landscape at a time, optionally using a filter to limit the company set. Within the API, landscapes are accessed by id. To get the id for a given landscape, use the landscape API endpoint.<\/p>\n

Data may be returned in JSON or CSV format (except for the landscape endpoint, which is JSON only).<\/p>\n

Backing data will be refreshed (as a background task) as needed to meet the social data freshness for your particular plan. You can monitor data update status via the landscape status API endpoint.<\/p>\n<\/div><\/div><\/div>

<\/div><\/div><\/div>

Authentication<\/span><\/h3>

Authentication is done via an API key, which must be passed as a parameter in each API call. To generate or reset your API key, visit the account settings page<\/a>. Note that the API key is per-user, not per-account.<\/p>\n<\/div><\/div><\/div>

<\/div><\/div><\/div>

Rate Limits<\/span><\/h3>

We enforce two types of limits to prevent runaway API usage. First, we allow a maximum of one simultaneous call per account. If you exceed this, you will receive a ConcurrencyLimitExceeded error. We recommend having an exponential backoff strategy in your client code for retries. Second, we allow a maximum of 100 calls per UTC clock hour per account. Exceeding this limit will result in an HourRateLimitExceeded error. Each of these limits is enforced collectively across all API keys for a given account, not separately. These limits are subject to change by Rival IQ if needed to maintain server performance.<\/p>\n<\/div><\/div><\/div>

<\/div><\/div><\/div>

Versioning<\/span><\/h3>

As we add new capabilities to the API over time, we will release new versions, following semantic versioning practices. We will not intentionally make breaking changes to existing API versions (although of course bug fixes and the like may cause slight differences). When a new version of the API is released, the prior API version will be supported for three months as of that release date. Once that sunset date is reached, the old API version will be disabled.<\/p>\n<\/div><\/div><\/div><\/div>

Get Started<\/span><\/h3>

Ready to dive in? Take a look at the API reference<\/a> documentation now.<\/p>\n<\/div><\/div><\/div><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":4,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"template-blank-4.php","meta":{"_acf_changed":false,"footnotes":""},"acf":[],"yoast_head":"\nRival IQ API for Developers | Rival IQ<\/title>\n<meta name=\"description\" content=\"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.rivaliq.com\/developers\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Developers\" \/>\n<meta property=\"og:description\" content=\"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.rivaliq.com\/developers\/\" \/>\n<meta property=\"og:site_name\" content=\"Rival IQ\" \/>\n<meta property=\"article:modified_time\" content=\"2024-04-16T22:42:38+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.rivaliq.com\/wp-content\/uploads\/2019\/11\/rivaliq-default-featured-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1202\" \/>\n\t<meta property=\"og:image:height\" content=\"629\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"8 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.rivaliq.com\/developers\/\",\"url\":\"https:\/\/www.rivaliq.com\/developers\/\",\"name\":\"Rival IQ API for Developers | Rival IQ\",\"isPartOf\":{\"@id\":\"https:\/\/www.rivaliq.com\/#website\"},\"datePublished\":\"2017-01-24T08:47:54+00:00\",\"dateModified\":\"2024-04-16T22:42:38+00:00\",\"description\":\"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.rivaliq.com\/developers\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.rivaliq.com\/developers\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.rivaliq.com\/developers\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.rivaliq.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developers\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.rivaliq.com\/#website\",\"url\":\"https:\/\/www.rivaliq.com\/\",\"name\":\"Rival IQ\",\"description\":\"Social Media Analytics\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.rivaliq.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Rival IQ API for Developers | Rival IQ","description":"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.rivaliq.com\/developers\/","og_locale":"en_US","og_type":"article","og_title":"Developers","og_description":"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.","og_url":"https:\/\/www.rivaliq.com\/developers\/","og_site_name":"Rival IQ","article_modified_time":"2024-04-16T22:42:38+00:00","og_image":[{"width":1202,"height":629,"url":"https:\/\/www.rivaliq.com\/wp-content\/uploads\/2019\/11\/rivaliq-default-featured-1.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"8 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.rivaliq.com\/developers\/","url":"https:\/\/www.rivaliq.com\/developers\/","name":"Rival IQ API for Developers | Rival IQ","isPartOf":{"@id":"https:\/\/www.rivaliq.com\/#website"},"datePublished":"2017-01-24T08:47:54+00:00","dateModified":"2024-04-16T22:42:38+00:00","description":"The Rival IQ API is a REST interface that provides programmatic access to the same data that you can view within the app.","breadcrumb":{"@id":"https:\/\/www.rivaliq.com\/developers\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.rivaliq.com\/developers\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.rivaliq.com\/developers\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.rivaliq.com\/"},{"@type":"ListItem","position":2,"name":"Developers"}]},{"@type":"WebSite","@id":"https:\/\/www.rivaliq.com\/#website","url":"https:\/\/www.rivaliq.com\/","name":"Rival IQ","description":"Social Media Analytics","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.rivaliq.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/pages\/526"}],"collection":[{"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/comments?post=526"}],"version-history":[{"count":15,"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/pages\/526\/revisions"}],"predecessor-version":[{"id":35239,"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/pages\/526\/revisions\/35239"}],"wp:attachment":[{"href":"https:\/\/www.rivaliq.com\/wp-json\/wp\/v2\/media?parent=526"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}