Shares API

The Analytics 2.0 Shares APIs allow you to retrieve, update, or create associations with components programmatically through Adobe Developer. The APIs use the same data and methods that Adobe uses in the product UI.

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

Retrieve multiple shares

Retrieve a list of shares that the user can access.

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

You can paginate results by using the limit and page query strings.

limit: An integer that represents the number of results per page.
page: An integer that represents which page to return results.

For example, use the page and limit query strings to only retrieve the first 3 shares in a company:

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares?page=0&limit=3" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}' \
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares?page=0&limit=3" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}' \

{
  "content": [
    {
      "shareId": 2085535,
      "shareToId": 622293,
      "shareToType": "user",
      "componentType": "segment",
      "componentId": "s300006186_590cb8b9e4b0ca84fe8152b9",
      "shareToDisplayName": null
    },
    {
      "shareId": 11684455,
      "shareToId": 239343,
      "shareToType": "group",
      "componentType": "segment",
      "componentId": "s300006186_5f4eb5bc3f56a12f743e1405",
      "shareToDisplayName": null
    },
    {
      "shareId": 11684456,
      "shareToId": 622291,
      "shareToType": "user",
      "componentType": "segment",
      "componentId": "s300006186_5f4eb5bb8aca3c5a990878e8",
      "shareToDisplayName": null
    }
  ],
  "totalPages": 38,
  "totalElements": 113,
  "number": 0,
  "numberOfElements": 3,
  "firstPage": true,
  "lastPage": false,
  "sort": null,
  "size": 3
}
Copied to your clipboard
{
  "content": [
    {
      "shareId": 2085535,
      "shareToId": 622293,
      "shareToType": "user",
      "componentType": "segment",
      "componentId": "s300006186_590cb8b9e4b0ca84fe8152b9",
      "shareToDisplayName": null
    },
    {
      "shareId": 11684455,
      "shareToId": 239343,
      "shareToType": "group",
      "componentType": "segment",
      "componentId": "s300006186_5f4eb5bc3f56a12f743e1405",
      "shareToDisplayName": null
    },
    {
      "shareId": 11684456,
      "shareToId": 622291,
      "shareToType": "user",
      "componentType": "segment",
      "componentId": "s300006186_5f4eb5bb8aca3c5a990878e8",
      "shareToDisplayName": null
    }
  ],
  "totalPages": 38,
  "totalElements": 113,
  "number": 0,
  "numberOfElements": 3,
  "firstPage": true,
  "lastPage": false,
  "sort": null,
  "size": 3
}

Returns information around a single share if you know the share ID.

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

For example, return information around the share with ID 11684455:

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/11684455" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/11684455" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'

{
  "shareId": 11684455,
  "shareToId": 239343,
  "shareToType": "group",
  "componentType": "segment",
  "componentId": "s300006186_5f4eb5bc3f56a12f743e1405",
  "shareToDisplayName": null
}
Copied to your clipboard
{
  "shareId": 11684455,
  "shareToId": 239343,
  "shareToType": "group",
  "componentType": "segment",
  "componentId": "s300006186_5f4eb5bc3f56a12f743e1405",
  "shareToDisplayName": null
}

Retrieve shares for multiple components

Finds one or more shares with desired values.

POST https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/component/search

This API call requires a JSON request body to determine search criteria. For example:

{
  "componentType": "segment",
  "componentIds": [
    "example-component-1"
  ]
}
Copied to your clipboard
{
  "componentType": "segment",
  "componentIds": [
    "example-component-1"
  ]
}

This API call sends a JSON request body with search criteria. Adobe returns the first three shares that involve the segment with ID 92845.

Request

Response

curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/component/search?page=0&limit=3" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '{"componentType": "segment","componentIds": ["92845"]}'
Copied to your clipboard
curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/component/search?page=0&limit=3" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '{"componentType": "segment","componentIds": ["92845"]}'

{
  "content": [
    {
      "componentType": "segment",
      "componentId": "92845",
      "shares": [
        {
          "shareId": 11684456,
          "shareToId": 622291,
          "shareToType": "user",
          "componentType": "segment",
          "componentId": "92845",
          "shareToDisplayName": null
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "number": 0,
  "numberOfElements": 1,
  "firstPage": true,
  "lastPage": true,
  "sort": null,
  "size": 10
}
Copied to your clipboard
{
  "content": [
    {
      "componentType": "segment",
      "componentId": "92845",
      "shares": [
        {
          "shareId": 11684456,
          "shareToId": 622291,
          "shareToType": "user",
          "componentType": "segment",
          "componentId": "92845",
          "shareToDisplayName": null
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "number": 0,
  "numberOfElements": 1,
  "firstPage": true,
  "lastPage": true,
  "sort": null,
  "size": 10
}

Retrieve components shared to current user

Returns an array of all components of a type shared to the user making the API call.

GET https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/sharedto/me?componentType={COMPONENT_TYPE}

This API call requires the componentType query string. Valid values include:

dashboard
bookmark
calculatedMetric
project
dateRange
metric
dimension
virtualReportSuite
scheduledJob
alert
classificationSet

For example, get all calculated metrics shared with me:

Request

Response

curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/sharedto/me?componentType=calculatedMetric" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'
Copied to your clipboard
curl -X GET "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/sharedto/me?componentType=calculatedMetric" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'

[
  "example-calculated-metric-id-1"
]
Copied to your clipboard
[
  "example-calculated-metric-id-1"
]

Shares a component with a group.

POST https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares

This API call requires a JSON body that determines what component to share and who to share it with. For example:

{
  "componentId": "{COMPONENTID}",
  "componentType": "{COMPONENTTYPE}",
  "shareToId": "{groupId}",
  "shareToType": "group"
}
Copied to your clipboard
{
  "componentId": "{COMPONENTID}",
  "componentType": "{COMPONENTTYPE}",
  "shareToId": "{groupId}",
  "shareToType": "group"
}

For example, share a segment with ID 83045 to a group with ID 38951:

Request

Response

curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '{"componentId": "83045",
  "componentType": "segment",
  "shareToId": 38951,
  "shareToType": "group"}'
Copied to your clipboard
curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '{"componentId": "83045",
  "componentType": "segment",
  "shareToId": 38951,
  "shareToType": "group"}'

{
  "shareId": 12345,
  "componentId": "83045",
  "componentType": "segment",
  "shareToId": 38951,
  "shareToType": "group"
}
Copied to your clipboard
{
  "shareId": 12345,
  "componentId": "83045",
  "componentType": "segment",
  "shareToId": 38951,
  "shareToType": "group"
}

Removes a share from a component.

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

For example, deletes a share with ID 11439.

Request

Response

curl -X DELETE "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/11439" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'
Copied to your clipboard
curl -X DELETE "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares/11439" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'x-api-key: {CLIENTID}'

{
  "shareId": 11439,
  "status": {
    "success": true
  }
}
Copied to your clipboard
{
  "shareId": 11439,
  "status": {
    "success": true
  }
}

Update shares for components

Set the shares for one or more components. This endpoint overwrites all existing shares for the component, meaning that existing shares are removed.

PUT https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares

This API call requires a JSON request body that contains the components to update and the tags to set. For example:

[
  {
    "componentType": "{COMPONENT_TYPE}",
    "componentId": "{ID}",
    "shares": [
      {
        "shareId": 11684456,
        "shareToId": 622291,
        "shareToType": "user",
        "componentType": "{COMPONENT_TYPE}",
        "componentId": "{ID}",
        "shareToDisplayName": null
      }
    ]
  }
]
Copied to your clipboard
[
  {
    "componentType": "{COMPONENT_TYPE}",
    "componentId": "{ID}",
    "shares": [
      {
        "shareId": 11684456,
        "shareToId": 622291,
        "shareToType": "user",
        "componentType": "{COMPONENT_TYPE}",
        "componentId": "{ID}",
        "shareToDisplayName": null
      }
    ]
  }
]

For example, creates a share to segment with ID 48372 to user with ID 622291. If there are any existing shares associated with this segment, those shares are lost.

Request

Response

curl -X PUT "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '[{"componentType": "segment",
    "componentId": "48372",
    "shares": [{
        "shareId": 11684456,
        "shareToId": 622291,
        "shareToType": "user",
        "componentType": "segment",
        "componentId": "48372",
        "shareToDisplayName": null
      }]}]'
Copied to your clipboard
curl -X PUT "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/componentmetadata/shares" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESSTOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {CLIENTID}' \
  -d '[{"componentType": "segment",
    "componentId": "48372",
    "shares": [{
        "shareId": 11684456,
        "shareToId": 622291,
        "shareToType": "user",
        "componentType": "segment",
        "componentId": "48372",
        "shareToDisplayName": null
      }]}]'

[
  {
    "componentType": "segment",
    "componentId": "48372",
    "shares": [
      {
        "shareToId": 622291,
        "shareToType": "user",
        "accessLevel": null
      }
    ],
    "status": {
      "success": true
    }
  }
]
Copied to your clipboard
[
  {
    "componentType": "segment",
    "componentId": "48372",
    "shares": [
      {
        "shareToId": 622291,
        "shareToType": "user",
        "accessLevel": null
      }
    ],
    "status": {
      "success": true
    }
  }
]

Shares API

Retrieve multiple shares.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Retrieve a single share by ID

Retrieve shares for multiple components

Retrieve components shared to current user

Create a share

Delete a share

Update shares for components

Retrieve multiple shares