The AchieveIt REST API lets you automate publishing data into your plans and exporting plan data from your account. This article covers the prerequisites, security requirements, and capabilities provided by the API.
Prerequisites
In order to use the API, you need to have:
API access enabled for your AchieveIt organization.
An API key.
Optionally, an “API service account” (a user in AchieveIt to which API-driven changes will be attributed).
Basic Security Requirements
Every request to an API endpoint must meet these security rules:
Must include your API key in the
Authorizationheader.Must be sent over HTTPS using TLS minimum version 1.2.
Role-Based Security
The API applies the same role-based security rules as the AchieveIt web application. Each API key is tied to a user, and requests made with that key will only succeed if the associated user has permission to perform the action. For convenience, you can create a dedicated “API service account” to use with the API. This account must be granted access to any plans and plan items you want to update or export.
Capabilities
You can automate many of the same actions you perform in the web application, making it easier to integrate AchieveIt with your other systems. The API supports submitting updates to plan items and exporting information out of plans.
Submitting Updates to Plan Items
You can publish progress updates and metrics updates for plan items. This will help you automate adding metrics into your AchieveIt plans and dashboards by publishing that data directly from source systems.
The API allows you to import multiple updates in one request in JSON or CSV formats. Each update record in your import needs to have an externalID that maps to a specific plan item. You can export a list of the externalIDs for a plan using "Export Internal IDs" option in the Options menu on the root plan item of any plan you're an admin of.
Read more details about how to submit each type of update:
Exporting Plan Data
You can retrieve information on all plan items in a specific plan You might want to do this if you are making your own backups of plan information, or if you want to take some pieces of the data being tracked in plans and include it in your own data management systems.