v1

latestSwagger 2.02026-07-175658186.8 KB

Projects

Retrieve user's projects

This Returns the projects list primarily for the Analytics product.

get/{globalCompanyId}/projects

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

includeTypestring[]

Include additional projects not owned by user. The "all" option takes precedence over "shared". If neither guided, or project is included, both types are returned

expansionstring[]

Comma-delimited list of additional project metadata fields to include on response.

filterByIdsstring

Filter list to only include projects in the specified list (comma-delimited list of IDs)

localestring

Locale

pagination'true' | 'false'

return paginated results

ownerIdinteger

Filter list to only include projects owned by the specified loginId

limitinteger

Number of results per page

pageinteger

Page number (base 0 - first page is "0")

Headers

Authorizationstring required

The access token copied from your AA API client integration, prefixed with "Bearer ".

x-api-keystring required

The API key copied from your AA API client integration. For more information on how to obtain this value, see Getting started with the Analytics API.

Response

successful operation

idstring

System generated id

namestring

descriptionstring

rsidstring

The report suite id for which the component was created/updated

reportSuiteNamestring

The report suite name for which the component was created/updated

migratedIdsstring[]

companyTemplateboolean

templateboolean

type'project' | 'mobileScorecard'

externalReferencesobject

accessLevelstring

versionNotesstring

tagsobject[]

sharesobject[]

approvedboolean

favoriteboolean

usageSummaryobject

complexityobject

siteTitlestring

modifiedstring date-time

createdstring date-time