Edit in GitHubLog an issue

Projects API

The Analytics 2.0 Projects APIs allow you to retrieve, update, or create projects programmatically through Adobe Developer. These APIs use the same data and methods that Adobe uses inside the product UI.

Retrieve multiple projects#

See Project parameters for a list of query strings that you can attach to this API call.

GET https://analytics.adobe.io/api/{GLOBALCOMPANYID}/projects

For example, get a response localized in English, limited to the first page, with three responses per page.

Copied to your clipboard
1curl -X GET "https://analytics.adobe.io/api/exampleco/projects?locale=en_US&limit=3&page=0" \
2 -H "x-api-key: {OAUTHTOKEN}" \
3 -H "Authorization: Bearer {ACCESSTOKEN}"

Retrieve a single project#

You can retrieve details around a single project if you know the project ID. You can find the project ID by looking in the debugger or using the multiple projects endpoint.

GET https://analytics.adobe.io/api/{GLOBALCOMPANYID}/projects/{ID}

For example, find details around the project with an ID of 6091a:

Copied to your clipboard
1curl -X GET "https://analytics.adobe.io/api/exampleco/projects/6091a" \
2 -H "x-api-key: {CLIENTID}" \
3 -H "Authorization: Bearer {ACCESSTOKEN}"

Delete a project#

When you delete a project, it is hidden from all users in all menus. It is also hidden from API calls to the multiple projects endpoint. You can still retrieve details on a deleted project if you still have the project ID.

DELETE https://analytics.adobe.io/api/{GLOBALCOMPANYID}/projects/{ID}

For example, delete a project with the ID of c7706c:

Copied to your clipboard
1curl -X DELETE "https://analytics.adobe.io/api/exampleco/projects/c7706c" \
2 -H "x-api-key: {CLIENTID}" \
3 -H "Authorization: Bearer {ACCESSTOKEN}"

Update a project#

You can edit projects using PUT API calls. It supports partial updates, meaning that instead of sending an entire project JSON object, you can only send the fields that you want to update. This API call requires a JSON body, which determines the parts of a project that you want to update.

PUT https://analytics.adobe.io/api/{GLOBALCOMPANYID}/projects/{ID}

For example, only update the name of the project with an ID of cdd751:

Copied to your clipboard
1curl -X PUT "https://analytics.adobe.io/api/exampleco/projects/cdd751" \
2 -H "x-api-key: {CLIENTID}" \
3 -H "Authorization: Bearer {ACCESSTOKEN}" \
4 -H "Content-Type: application/json" \
5 -d '{"name":"Different project name"}'

Validate#

Report suites can have different configurations, variables or metrics. One project that is valid in one report suite might not be valid in another. You can use this endpoint to make sure that a project is compatible with a report suite.

This API call requires a JSON request body, which is a project definition. It also requires a report suite ID so it knows which report suite to validate the project against.

POST https://analytics.adobe.io/api/{GLOBALCOMPANYID}/projects/validate?rsid={RSID}

For example, validate a basic project against the report suite apptestpnwtest:

Copied to your clipboard
1curl -X POST "https://analytics.adobe.io/api/exampleco/projects/validate?rsid=apptestpnwtest" \
2 -H "x-api-key: {CLIENTID}" \
3 -H "Content-Type: application/json" \
4 -H "Authorization: Bearer {ACCESSTOKEN}" \
5 -d '{
6 "project": {
7 "id": "6091a10005c7706c0acdd751",
8 "name": "New Project",
9 "description": "",
10 "rsid": "apptestpnwtest",
11 "owner": {"id": 622291},
12 "type": "project",
13 "definition": {See the project definition page for a full example definition},
14 "created": "YYYY-05-04T19:31:12Z"
15 }
16 }'
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.