{"_id":"55dc55e627c8180d00e68aa7","excerpt":"This page will help you get started with version 2 of the ActivityInfo API.","type":"basic","updates":[],"api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"parentDoc":null,"slug":"getting-started","title":"Introduction","user":"548ef7d8ff3cbe0b00e77c77","createdAt":"2014-12-15T15:04:34.335Z","link_url":"","project":"548ef880ff3cbe0b00e77c7a","link_external":false,"order":0,"sync_unique":"","__v":5,"body":"The ActivityInfo API allows you to query and update public and private ActivityInfo databases. You can also push updates to ActivityInfo databases for which you have write permissions.\n\nActivityInfo offers a JSON-based API that mostly follows RESTful principles, so you can either use your favorite REST client library to send and receive JSON, or you can use a client library for R or Python for convenience.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using the R Client Library\"\n}\n[/block]\nUsing the R client library makes it especially easy to extend ActivityInfo with ad hoc or even interactive analysis. If you're already familiar with R, you can get started with a few lines:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# ensure that the 'devtools' package is installed and loaded:\\ninstall.packages(\\\"devtools\\\")\\nlibrary(devtools)\\n\\n# install the 'activityinfo' package from GitHub:\\ninstall_github( \\\"bedatadriven/activityinfo-R\\\", ref = \\\"release\\\")\\n\\n# load the 'activityinfo' package in the R session:\\nlibrary(activityinfo)\",\n      \"language\": \"r\",\n      \"name\": \"R\"\n    }\n  ]\n}\n[/block]","category":"55dc55e527c8180d00e68aa4","githubsync":"","hidden":false,"version":"55dc55e527c8180d00e68aa3","childrenPages":[]}

Introduction

This page will help you get started with version 2 of the ActivityInfo API.

The ActivityInfo API allows you to query and update public and private ActivityInfo databases. You can also push updates to ActivityInfo databases for which you have write permissions. ActivityInfo offers a JSON-based API that mostly follows RESTful principles, so you can either use your favorite REST client library to send and receive JSON, or you can use a client library for R or Python for convenience. [block:api-header] { "type": "basic", "title": "Using the R Client Library" } [/block] Using the R client library makes it especially easy to extend ActivityInfo with ad hoc or even interactive analysis. If you're already familiar with R, you can get started with a few lines: [block:code] { "codes": [ { "code": "# ensure that the 'devtools' package is installed and loaded:\ninstall.packages(\"devtools\")\nlibrary(devtools)\n\n# install the 'activityinfo' package from GitHub:\ninstall_github( \"bedatadriven/activityinfo-R\", ref = \"release\")\n\n# load the 'activityinfo' package in the R session:\nlibrary(activityinfo)", "language": "r", "name": "R" } ] } [/block]