{"id":565,"date":"2019-11-19T13:58:15","date_gmt":"2019-11-19T13:58:15","guid":{"rendered":"https:\/\/capturly.com\/documentation\/?p=565"},"modified":"2023-02-01T12:13:55","modified_gmt":"2023-02-01T12:13:55","slug":"capturlys-rest-api","status":"publish","type":"post","link":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/","title":{"rendered":"Capturly\u2019s REST API"},"content":{"rendered":"

Capturly\u2019s REST API (Application Programming Interface) is a platform to communicate with our servers and export the tracked data of your websites.<\/span><\/p>\n

Please note that this API is a beta version and it will be updated with additional features in the future. If you have any request or suggestion, please feel free to send it to us at hello@capturly.com.<\/span><\/i><\/p>\n

How does the Capturly REST API works?<\/b><\/p>\n

The Capturly\u2019s REST API allows you to request data from our servers. In order to authenticate the request, you should use your own API key as a query parameter.<\/span><\/p>\n

In the header, you should define the exact format of the answer which can be a JSON or an XML.<\/span><\/p>\n

Example of sending a request:<\/span><\/p>\n

 <\/p>\n

curl -X GET -i -H \"Accept:application\/json\"\n\"https:\/\/api.capturly.com\/v0\/recordings\/[websiteId]?apiKey=[apiKey]\"<\/code><\/pre>\n
 <\/p>\n
The current version of the REST API allows you to request a list of your session replays with the GET method:<\/span><\/p>\n
 <\/p>\n
https:\/\/api.capturly.com\/v0\/recordings\/[websiteID]?apiKey=[apiKey]<\/code><\/pre>\n
 <\/p>\n
The current version of the REST API allows you to request a list of your session replays with the GET method:<\/span><\/p>\n
Please note that the apiKey is unique and it is used for authenticating the user making the request. According to this, please don\u2019t share your apiKey and keep it private.<\/span><\/i><\/p>\n
 <\/p>\n
This list contains the public URL of your recordings as well, it can be found in the url column of the list. The complete list structure is the following:<\/span><\/p>\n
aaaaaaaaa
\n[<\/span><\/p>\n
  {<\/span><\/p>\n
    “startPage”: …,<\/span><\/p>\n
    “endPage”: …,<\/span><\/p>\n
    “visitedPages”: …,<\/span><\/p>\n
    “country”: …,<\/span><\/p>\n
    “ip”: …,<\/span><\/p>\n
    “duration”: …,<\/span><\/p>\n
    “browser”: …,<\/span><\/p>\n
    “url”: …,<\/span><\/p>\n
    “createTime”: …<\/span><\/p>\n
  },<\/span><\/p>\n
  {<\/span><\/p>\n
    “startPage”: …,<\/span><\/p>\n
    “endPage”: …,<\/span><\/p>\n
    “visitedPages”: …,<\/span><\/p>\n
    “country”: …,<\/span><\/p>\n
    “ip”: …,<\/span><\/p>\n
    “duration”: …,<\/span><\/p>\n
    “browser”: …,<\/span><\/p>\n
    “url”: …,<\/span><\/p>\n
    “createTime”: …<\/span><\/p>\n
  },<\/span><\/p>\n
  …<\/span><\/p>\n
]<\/span><\/p>\n
 <\/p>\n
How can I request an API key?<\/b><\/p>\n
 <\/p>\n
If you would like to use the API you will need an API key (apiKey). You can request a unique API key (apiKey) by sending a request to hello@capturly.com.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
Capturly\u2019s REST API (Application Programming Interface) is a platform to communicate with our servers and export the tracked data of your websites. Please note that this API is a beta version and it will be updated with additional features in the future. If you have any request or suggestion, please feel free to send it […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"yoast_head":"\nCapturly\u2019s REST API - Capturly Documentation<\/title>\n<meta name=\"description\" content=\"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Capturly\u2019s REST API - Capturly Documentation\" \/>\n<meta property=\"og:description\" content=\"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey\" \/>\n<meta property=\"og:url\" content=\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Capturly Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2019-11-19T13:58:15+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-02-01T12:13:55+00:00\" \/>\n<meta name=\"author\" content=\"Gabriella J\u00e1mbor\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Gabriella J\u00e1mbor\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/\",\"url\":\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/\",\"name\":\"Capturly\u2019s REST API - Capturly Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/capturly.com\/documentation\/#website\"},\"datePublished\":\"2019-11-19T13:58:15+00:00\",\"dateModified\":\"2023-02-01T12:13:55+00:00\",\"author\":{\"@id\":\"https:\/\/capturly.com\/documentation\/#\/schema\/person\/0b8e591793613c3903a843ba859ffa8d\"},\"description\":\"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey\",\"breadcrumb\":{\"@id\":\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/capturly.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Capturly\u2019s REST API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/capturly.com\/documentation\/#website\",\"url\":\"https:\/\/capturly.com\/documentation\/\",\"name\":\"Capturly Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/capturly.com\/documentation\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/capturly.com\/documentation\/#\/schema\/person\/0b8e591793613c3903a843ba859ffa8d\",\"name\":\"Gabriella J\u00e1mbor\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/capturly.com\/documentation\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/5044a2221efb4543c929245d16082362?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/5044a2221efb4543c929245d16082362?s=96&d=mm&r=g\",\"caption\":\"Gabriella J\u00e1mbor\"},\"sameAs\":[\"http:\/\/capturly.com\"],\"url\":\"https:\/\/capturly.com\/documentation\/author\/gabriella\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Capturly\u2019s REST API - Capturly Documentation","description":"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey","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:\/\/capturly.com\/documentation\/capturlys-rest-api\/","og_locale":"en_US","og_type":"article","og_title":"Capturly\u2019s REST API - Capturly Documentation","og_description":"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey","og_url":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/","og_site_name":"Capturly Documentation","article_published_time":"2019-11-19T13:58:15+00:00","article_modified_time":"2023-02-01T12:13:55+00:00","author":"Gabriella J\u00e1mbor","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Gabriella J\u00e1mbor","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/","url":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/","name":"Capturly\u2019s REST API - Capturly Documentation","isPartOf":{"@id":"https:\/\/capturly.com\/documentation\/#website"},"datePublished":"2019-11-19T13:58:15+00:00","dateModified":"2023-02-01T12:13:55+00:00","author":{"@id":"https:\/\/capturly.com\/documentation\/#\/schema\/person\/0b8e591793613c3903a843ba859ffa8d"},"description":"Access and export the tracked data of your websites with Capturly's REST API. Learn how to authenticate the request with your apiKey","breadcrumb":{"@id":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/capturly.com\/documentation\/capturlys-rest-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/capturly.com\/documentation\/capturlys-rest-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/capturly.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Capturly\u2019s REST API"}]},{"@type":"WebSite","@id":"https:\/\/capturly.com\/documentation\/#website","url":"https:\/\/capturly.com\/documentation\/","name":"Capturly Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/capturly.com\/documentation\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/capturly.com\/documentation\/#\/schema\/person\/0b8e591793613c3903a843ba859ffa8d","name":"Gabriella J\u00e1mbor","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/capturly.com\/documentation\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/5044a2221efb4543c929245d16082362?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/5044a2221efb4543c929245d16082362?s=96&d=mm&r=g","caption":"Gabriella J\u00e1mbor"},"sameAs":["http:\/\/capturly.com"],"url":"https:\/\/capturly.com\/documentation\/author\/gabriella\/"}]}},"_links":{"self":[{"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/posts\/565"}],"collection":[{"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/comments?post=565"}],"version-history":[{"count":6,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/posts\/565\/revisions"}],"predecessor-version":[{"id":781,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/posts\/565\/revisions\/781"}],"wp:attachment":[{"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/media?parent=565"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/categories?post=565"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/capturly.com\/documentation\/wp-json\/wp\/v2\/tags?post=565"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}