# Adobe Analytics

> Run Adobe Analytics reports, trends and totals, manage segments and annotations, and start workflows when segments, projects, annotations or new dimension values appear.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/adobe-analytics

## Actions

### Create annotation

Add an annotation to a report suite's reports, marking a day or days such as a launch, a campaign or an outage.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Name (`name`, text, required): The annotation's name, shown on the reports.
- From (`start_date`, date, required): The first day it marks.
- Until (`end_date`, date): The last day it marks. Defaults to the first day.
- Color (`color`, text): The annotation's color in reports, one of Adobe's nine. One of: `STANDARD1` (Color 1 (default)), `STANDARD2` (Color 2), `STANDARD3` (Color 3), `STANDARD4` (Color 4), `STANDARD5` (Color 5), `STANDARD6` (Color 6), `STANDARD7` (Color 7), `STANDARD8` (Color 8), `STANDARD9` (Color 9).
- Description (`description`, text): A longer note shown with it.
- Show on every report suite (`apply_to_all_reports`, true/false): Turn on to show the annotation on every report suite, not just this one.

**Outputs**

- `annotation` (object): The new annotation

**Example output**

```json
{
  "annotation": {
    "applyToAllReports": false,
    "color": "STANDARD1",
    "createdDate": "2026-03-23T01:51:28.686Z",
    "dateRange": "2026-03-29T00:00:00/2026-03-29T23:59:59",
    "description": "Homepage banner went live",
    "id": "62437d",
    "modifiedDate": "2026-03-23T01:51:28.686Z",
    "name": "Spring sale launch",
    "owner": {
      "id": 596983,
      "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ]
  }
}
```

### Create segment

Create a segment of one rule, such as visits where Page contains checkout, for use in reports and virtual report suites.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Name (`name`, text, required): The segment's name.
- Keep (`container`, text): How much data a match keeps. Defaults to only the matching hits. One of: `hits` (Hit: only the page views or events that match), `visits` (Visit: whole visits with a match), `visitors` (Visitor: everything from visitors with a match).
- Where (`dimension`, text, required): The dimension the rule looks at, such as Page. Pick a report suite first, or give an id such as variables/page.
- Comparison (`operator`, text): How the dimension is compared. Defaults to Equals. One of: `streq` (Equals), `not-streq` (Does not equal), `contains`, `not-contains` (Does not contain), `starts-with` (Starts with), `ends-with` (Ends with), `exists` (Has any value), `not-exists` (Has no value).
- Value (`value`, text): The text to compare with. Not needed for Has any value or Has no value.
- Description (`description`, text): A longer note shown with it.

**Outputs**

- `segment` (object): The new segment

**Example output**

```json
{
  "segment": {
    "description": "Visits that reached checkout",
    "id": "s300000022_5bb7c94e80f0073611afb35c",
    "modified": "2026-11-01T09:00:00Z",
    "name": "Checkout visits",
    "owner": {
      "id": 596983,
      "login": "jbloggs",
      "name": "Jo Bloggs"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ]
  }
}
```

### Delete annotation

Delete an annotation, removing it from every report.

**Inputs**

- Annotation (`annotation_id`, text, required): The annotation. Pick one, or give its id.

**Outputs**

- `annotation_id` (text): The deleted annotation's id
- `deleted` (true/false): True once it is deleted

**Example output**

```json
{
  "annotation_id": "62437d",
  "deleted": true
}
```

### Delete segment

Delete a segment, hiding it from everyone. Reports that already use it keep working.

**Inputs**

- Segment (`segment_id`, text, required): The segment. Pick one, or give its id.

**Outputs**

- `deleted` (true/false): True once it is deleted
- `segment_id` (text): The deleted segment's id

**Example output**

```json
{
  "deleted": true,
  "segment_id": "s300000022_5bb7c94e80f0073611afb35c"
}
```

### Get annotation

Get one annotation with its dates, color, description and report suite.

**Inputs**

- Annotation (`annotation_id`, text, required): The annotation. Pick one, or give its id.

**Outputs**

- `annotation` (object): The annotation

**Example output**

```json
{
  "annotation": {
    "applyToAllReports": false,
    "color": "STANDARD1",
    "createdDate": "2026-03-23T01:51:28.686Z",
    "dateRange": "2026-03-29T00:00:00/2026-03-29T23:59:59",
    "description": "Homepage banner went live",
    "id": "62437d",
    "modifiedDate": "2026-03-23T01:51:28.686Z",
    "name": "Spring sale launch",
    "owner": {
      "id": 596983,
      "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ]
  }
}
```

### Get calculated metric

Get one calculated metric with its formula and format.

**Inputs**

- Calculated metric (`calculated_metric_id`, text, required): The calculated metric. Pick one, or give its id (it starts with cm).

**Outputs**

- `calculated_metric` (object): The calculated metric

**Example output**

```json
{
  "calculated_metric": {
    "categories": [
      "Commerce"
    ],
    "compatibility": {
      "validator_version": "1.0"
    },
    "definition": {
      "formula": {
        "col1": {
          "func": "metric",
          "name": "metrics/revenue"
        },
        "col2": {
          "func": "metric",
          "name": "metrics/visits"
        },
        "func": "divide"
      },
      "func": "calc-metric",
      "version": [
        1,
        0,
        0
      ]
    },
    "description": "Revenue divided by visits",
    "id": "cm300000022_5bb7c94e80f0073611afb35d",
    "modified": "2026-11-02T09:00:00Z",
    "name": "Revenue per visit",
    "owner": {
      "id": 596983,
      "login": "jbloggs",
      "name": "Jo Bloggs"
    },
    "polarity": "positive",
    "precision": 2,
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ],
    "type": "CURRENCY"
  }
}
```

### Get connected user

Get the Analytics user this connection acts as: the credential's technical account. A quick way to check the connection works.

**Inputs**: None.

**Outputs**

- `user` (object): The connected user

**Example output**

```json
{
  "user": {
    "companyid": 300000022,
    "createDate": "2026-01-15T10:00:00Z",
    "disabled": false,
    "email": "jo@example.com",
    "firstName": "Jo",
    "fullName": "Jo Bloggs",
    "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID",
    "lastAccess": "2026-11-12T08:30:00Z",
    "lastName": "Bloggs",
    "login": "jbloggs",
    "loginId": 596983,
    "title": "Analyst"
  }
}
```

### Get metric totals

Get the totals of one or more metrics (such as visits and orders) for a date range, optionally within a segment.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Metrics (`metrics`, list, required): What to count, such as Page Views or Visits. Pick a report suite first, or give ids such as metrics/pageviews or a calculated metric's id.
- Date range (`date_range`, text): Which dates to report on, in the report suite's time zone. Defaults to the last 30 days, not counting today. One of: `last_30_days` (Last 30 days (default)), `today`, `yesterday`, `last_7_days` (Last 7 days), `last_90_days` (Last 90 days), `this_week` (This week), `last_week` (Last week), `this_month` (This month), `last_month` (Last month), `this_quarter` (This quarter), and 4 more.
- From (`start_date`, date): The first day to report on. Only when Date range is Between two dates.
- Until (`end_date`, date): The last day to report on, included. Defaults to the first day. Only when Date range is Between two dates.
- Segment (`segment_id`, text): Only count the data in this segment. Leave empty for all data.

**Outputs**

- `column_errors` (list): Metrics Adobe could not report, with its reason
- `date_range` (text): The date range as sent to Adobe
- `metrics` (list): The metrics reported, in order
- `totals` (object): Each metric's total, by metric id

**Example output**

```json
{
  "column_errors": [],
  "date_range": "td-30d/td",
  "metrics": [
    "metrics/pageviews",
    "metrics/visits"
  ],
  "totals": {
    "metrics/pageviews": 3080619,
    "metrics/visits": 424407
  }
}
```

### Get project

Get one Analysis Workspace project with who it is shared with, and optionally its full layout of panels and tables.

**Inputs**

- Project (`project_id`, text, required): The project. Pick one, or give its id.
- Include layout (`include_definition`, true/false): Turn on to include the project's panels and tables. It can be large.

**Outputs**

- `project` (object): The project

**Example output**

```json
{
  "project": {
    "accessLevel": "edit",
    "definition": null,
    "description": "Traffic by channel",
    "id": "5b4e4ee5a2c2a10c3b8b456c",
    "modified": "2026-11-03T09:00:00Z",
    "name": "Weekly traffic",
    "owner": {
      "id": 596983,
      "login": "jbloggs",
      "name": "Jo Bloggs"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "shares": [
      {
        "shareToId": 596984,
        "shareToType": "user"
      }
    ],
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ],
    "type": "project"
  }
}
```

### Get segment

Get one segment with its rules, report suite and owner.

**Inputs**

- Segment (`segment_id`, text, required): The segment. Pick one, or give its id.

**Outputs**

- `segment` (object): The segment

**Example output**

```json
{
  "segment": {
    "categories": [
      "Content"
    ],
    "compatibility": {
      "valid": true
    },
    "definition": {
      "container": {
        "context": "visits",
        "func": "container",
        "pred": {
          "func": "contains",
          "str": "checkout",
          "val": {
            "func": "attr",
            "name": "variables/page"
          }
        }
      },
      "func": "segment",
      "version": [
        1,
        0,
        0
      ]
    },
    "definitionLastModified": "2026-11-01T09:00:00Z",
    "description": "Visits that reached checkout",
    "id": "s300000022_5bb7c94e80f0073611afb35c",
    "modified": "2026-11-01T09:00:00Z",
    "name": "Checkout visits",
    "owner": {
      "id": 596983,
      "login": "jbloggs",
      "name": "Jo Bloggs"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ]
  }
}
```

### Get top items

Get the top values of a dimension (the most-viewed pages, the busiest campaigns) between two dates, with Adobe's id for each.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Dimension (`dimension`, text, required): What to break the report down by, such as Page or Marketing Channel. Pick a report suite first, or give an id such as variables/page.
- From (`start_date`, date): The first day. Leave empty for Adobe's default range.
- Until (`end_date`, date): The last day. Defaults to the first day.
- Only values containing (`search`, text): Only keep values of the dimension that contain this text.
- Include Unspecified (`include_unspecified`, true/false): Turn on to keep the row Adobe calls Unspecified (no value set).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `dimension` (text): The dimension read
- `items` (list): The top values
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "dimension": "variables/page",
  "items": [
    {
      "item_id": "3306266643",
      "value": "home"
    }
  ],
  "next_page": 0,
  "page": 1,
  "total": 1
}
```

### Get trend over time

Get one or more metrics for each hour, day, week, month, quarter or year of a date range, oldest first, optionally within a segment.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Metrics (`metrics`, list, required): What to count, such as Page Views or Visits. Pick a report suite first, or give ids such as metrics/pageviews or a calculated metric's id.
- Each (`granularity`, text): How long each period is. Defaults to a day. One of: `day` (Day (default)), `hour`, `week`, `month`, `quarter`, `year`.
- Date range (`date_range`, text): Which dates to report on, in the report suite's time zone. Defaults to the last 30 days, not counting today. One of: `last_30_days` (Last 30 days (default)), `today`, `yesterday`, `last_7_days` (Last 7 days), `last_90_days` (Last 90 days), `this_week` (This week), `last_week` (Last week), `this_month` (This month), `last_month` (Last month), `this_quarter` (This quarter), and 4 more.
- From (`start_date`, date): The first day to report on. Only when Date range is Between two dates.
- Until (`end_date`, date): The last day to report on, included. Defaults to the first day. Only when Date range is Between two dates.
- Segment (`segment_id`, text): Only count the data in this segment. Leave empty for all data.

**Outputs**

- `column_errors` (list): Metrics Adobe could not report, with its reason
- `count` (number): How many periods there are
- `date_range` (text): The date range as sent to Adobe
- `granularity` (text): How long each period is
- `metrics` (list): The metrics reported, in order
- `periods` (list): The periods, oldest first
- `totals` (object): Each metric's total, by metric id

**Example output**

```json
{
  "column_errors": [],
  "count": 1,
  "date_range": "td-30d/td",
  "granularity": "day",
  "metrics": [
    "metrics/pageviews",
    "metrics/visits"
  ],
  "periods": [
    {
      "data": [
        10251,
        4210
      ],
      "item_id": "1261101",
      "metrics": {
        "metrics/pageviews": 10251,
        "metrics/visits": 4210
      },
      "period": "Nov 1, 2026"
    }
  ],
  "totals": {
    "metrics/pageviews": 3080619,
    "metrics/visits": 424407
  }
}
```

### List annotations

List annotations (notes on dates in reports, such as a launch or an outage), optionally only those within two dates. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Whose (`include`, text): Whose to list. Defaults to everything the connection can see; its own are those made through this connection. One of: `all` (Everything the connection can see (default)), `shared` (Its own and those shared with it), `mine` (Only its own).
- Within, from (`start_date`, date): Only annotations that fall entirely on or after this day.
- Within, until (`end_date`, date): And on or before this day. Needs the first day too.
- Order (`sort`, text): The order to list them in. Defaults to most recently changed first. One of: `recently_changed` (Most recently changed first (default)), `name` (By name, A to Z), `oldest` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `annotations` (list): The annotations
- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "annotations": [
    {
      "applyToAllReports": false,
      "color": "STANDARD1",
      "createdDate": "2026-03-23T01:51:28.686Z",
      "dateRange": "2026-03-29T00:00:00/2026-03-29T23:59:59",
      "description": "Homepage banner went live",
      "id": "62437d",
      "modifiedDate": "2026-03-23T01:51:28.686Z",
      "name": "Spring sale launch",
      "owner": {
        "id": 596983,
        "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID"
      },
      "reportSuiteName": "Example Suite",
      "rsid": "examplersid",
      "tags": [
        {
          "id": 1,
          "name": "Marketing"
        }
      ]
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total": 1
}
```

### List calculated metrics

List calculated metrics with their format, report suite and owner, optionally by name, report suite, favorites or approved ones. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Name contains (`name`, text): Only those whose name contains this text.
- Report suite (`rsid`, text): Only those made in this report suite. Leave empty for all.
- Whose (`include`, text): Whose to list. Defaults to everything the connection can see; its own are those made through this connection. One of: `all` (Everything the connection can see (default)), `shared` (Its own and those shared with it), `mine` (Only its own).
- Only favorites (`favorites_only`, true/false): Turn on to list only the connection's favorites.
- Only approved (`approved_only`, true/false): Turn on to list only those an admin approved.
- Order (`sort`, text): The order to list them in. Defaults to most recently changed first. One of: `recently_changed` (Most recently changed first (default)), `name` (By name, A to Z), `oldest` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `calculated_metrics` (list): The calculated metrics
- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "calculated_metrics": [
    {
      "description": "Revenue divided by visits",
      "id": "cm300000022_5bb7c94e80f0073611afb35d",
      "modified": "2026-11-02T09:00:00Z",
      "name": "Revenue per visit",
      "owner": {
        "id": 596983,
        "login": "jbloggs",
        "name": "Jo Bloggs"
      },
      "polarity": "positive",
      "precision": 2,
      "reportSuiteName": "Example Suite",
      "rsid": "examplersid",
      "tags": [
        {
          "id": 1,
          "name": "Marketing"
        }
      ],
      "type": "CURRENCY"
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total": 1
}
```

### List dimensions

List every dimension a report suite can be reported by (Page, Marketing Channel, eVars and props), with the id a report step takes.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Only those segments can use (`segmentable_only`, true/false): Turn on to list only those a segment can use.

**Outputs**

- `count` (number): How many there are
- `dimensions` (list): The dimensions

**Example output**

```json
{
  "count": 1,
  "dimensions": [
    {
      "category": "Content",
      "description": "The page name",
      "id": "variables/page",
      "name": "Page",
      "pathable": true,
      "segmentable": true,
      "title": "Page",
      "type": "STRING"
    }
  ]
}
```

### List metrics

List every standard metric a report suite has (Page Views, Visits, Orders, events), with the id a report step takes.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Only those segments can use (`segmentable_only`, true/false): Turn on to list only those a segment can use.

**Outputs**

- `count` (number): How many there are
- `metrics` (list): The metrics

**Example output**

```json
{
  "count": 1,
  "metrics": [
    {
      "calculated": false,
      "category": "Traffic",
      "description": "The number of times a page was viewed",
      "id": "metrics/pageviews",
      "name": "Page Views",
      "polarity": "positive",
      "precision": 0,
      "segmentable": true,
      "title": "Page Views",
      "type": "INT"
    }
  ]
}
```

### List projects

List Analysis Workspace projects with their report suite, owner and when they last changed. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Whose (`include`, text): Whose to list. Defaults to everything the connection can see; its own are those made through this connection. One of: `all` (Everything the connection can see (default)), `shared` (Its own and those shared with it), `mine` (Only its own).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `projects` (list): The projects
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "projects": [
    {
      "accessLevel": "edit",
      "description": "Traffic by channel",
      "id": "5b4e4ee5a2c2a10c3b8b456c",
      "modified": "2026-11-03T09:00:00Z",
      "name": "Weekly traffic",
      "owner": {
        "id": 596983,
        "login": "jbloggs",
        "name": "Jo Bloggs"
      },
      "reportSuiteName": "Example Suite",
      "rsid": "examplersid",
      "tags": [
        {
          "id": 1,
          "name": "Marketing"
        }
      ],
      "type": "project"
    }
  ],
  "total": 1
}
```

### List report suites

List your report suites (the data each site or app collects) with their id, name, currency and time zone. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- ID contains (`rsid_contains`, text): Only report suites whose id contains this text.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `report_suites` (list): The report suites
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "report_suites": [
    {
      "calendarType": {
        "anchorDate": "2026-01-01T00:00:00Z",
        "rsid": "examplersid",
        "type": "GREGORIAN"
      },
      "currency": "USD",
      "id": "examplersid",
      "name": "Example Suite",
      "parentRsid": "",
      "rsid": "examplersid",
      "timezoneZoneinfo": "US/Pacific"
    }
  ],
  "total": 1
}
```

### List saved date ranges

List the saved date ranges people use in Workspace, such as Last 6 full weeks, with their rule. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Whose (`include`, text): Whose to list. Defaults to everything the connection can see; its own are those made through this connection. One of: `all` (Everything the connection can see (default)), `shared` (Its own and those shared with it), `mine` (Only its own).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `date_ranges` (list): The date ranges
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "date_ranges": [
    {
      "definition": "tw-6w/tw",
      "description": "",
      "id": "5b4e4ee5a2c2a10c3b8b4570",
      "modified": "2026-10-20T09:00:00Z",
      "name": "Last 6 full weeks",
      "owner": {
        "id": 596983,
        "login": "jbloggs",
        "name": "Jo Bloggs"
      },
      "tags": [
        {
          "id": 1,
          "name": "Marketing"
        }
      ]
    }
  ],
  "next_page": 0,
  "page": 1,
  "total": 1
}
```

### List segments

List segments with their report suite, owner and when they last changed, optionally by name or report suite. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Name contains (`name`, text): Only those whose name contains this text.
- Report suite (`rsid`, text): Only those made in this report suite. Leave empty for all.
- Whose (`include`, text): Whose to list. Defaults to everything the connection can see; its own are those made through this connection. One of: `all` (Everything the connection can see (default)), `shared` (Its own and those shared with it), `mine` (Only its own).
- Order (`sort`, text): The order to list them in. Defaults to most recently changed first. One of: `recently_changed` (Most recently changed first (default)), `name` (By name, A to Z), `oldest` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `segments` (list): The segments
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "segments": [
    {
      "description": "Visits that reached checkout",
      "id": "s300000022_5bb7c94e80f0073611afb35c",
      "modified": "2026-11-01T09:00:00Z",
      "name": "Checkout visits",
      "owner": {
        "id": 596983,
        "login": "jbloggs",
        "name": "Jo Bloggs"
      },
      "reportSuiteName": "Example Suite",
      "rsid": "examplersid",
      "tags": [
        {
          "id": 1,
          "name": "Marketing"
        }
      ]
    }
  ],
  "total": 1
}
```

### List usage logs

List what people did in Adobe Analytics between two times (sign-ins, reports run, settings changed), optionally for one login, report suite or kind of event. Searches up to three months; needs an admin credential.

**Inputs**

- From (`start_time`, date and time, required): The earliest time to include.
- Until (`end_time`, date and time): The latest time to include. Defaults to now.
- Login (`login`, text): Only what this user did, by their Analytics login.
- Report suite (`rsid`, text): Only what involved this report suite.
- Event (`event`, text): Only events with exactly this description, such as User logged in.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `logs` (list): The log entries
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says

**Example output**

```json
{
  "count": 1,
  "logs": [
    {
      "dateCreated": "2026-11-12T08:30:00-07:00",
      "eventDescription": "User logged in",
      "eventType": "1",
      "ipAddress": "192.0.2.10",
      "login": "jbloggs",
      "rsid": ""
    }
  ],
  "next_page": 0,
  "page": 1,
  "total": 1
}
```

### List users

List the people who can use Adobe Analytics in your company, with their email and when they last signed in. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total": 1,
  "users": [
    {
      "companyid": 300000022,
      "createDate": "2026-01-15T10:00:00Z",
      "disabled": false,
      "email": "jo@example.com",
      "firstName": "Jo",
      "fullName": "Jo Bloggs",
      "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID",
      "lastAccess": "2026-11-12T08:30:00Z",
      "lastName": "Bloggs",
      "login": "jbloggs",
      "loginId": 596983,
      "title": "Analyst"
    }
  ]
}
```

### List virtual report suites

List virtual report suites (report suites seen through segments) with the report suite each is based on and the segments it applies. Gets one page; run it again with the next page it gives to see more.

**Inputs**

- Based on (`parent_rsid`, text): Only those based on this report suite.
- Using segment (`segment_id`, text): Only those that apply this segment.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `count` (number): How many are on this page
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `total` (number): How many there are in all, when Adobe says
- `virtual_report_suites` (list): The virtual report suites

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total": 1,
  "virtual_report_suites": [
    {
      "description": "Visits from mobile devices",
      "id": "vrs_exampleco_mobileonly",
      "modified": "2026-10-01T12:00:00Z",
      "name": "Mobile only",
      "parentRsid": "examplersid",
      "parentRsidName": "Example Suite",
      "segmentList": [
        "s300000022_5bb7c94e80f0073611afb35c"
      ],
      "timezoneZoneinfo": "US/Pacific"
    }
  ]
}
```

### Run report

Run a report like a Workspace freeform table: the top values of one dimension (such as pages) with the metrics you choose, for a date range and optionally a segment. Each row names its numbers by metric.

**Inputs**

- Report suite (`rsid`, text, required): The report suite (or virtual report suite) to read. Pick one, or give its id.
- Dimension (`dimension`, text, required): What to break the report down by, such as Page or Marketing Channel. Pick a report suite first, or give an id such as variables/page.
- Metrics (`metrics`, list, required): What to count, such as Page Views or Visits. Pick a report suite first, or give ids such as metrics/pageviews or a calculated metric's id.
- Date range (`date_range`, text): Which dates to report on, in the report suite's time zone. Defaults to the last 30 days, not counting today. One of: `last_30_days` (Last 30 days (default)), `today`, `yesterday`, `last_7_days` (Last 7 days), `last_90_days` (Last 90 days), `this_week` (This week), `last_week` (Last week), `this_month` (This month), `last_month` (Last month), `this_quarter` (This quarter), and 4 more.
- From (`start_date`, date): The first day to report on. Only when Date range is Between two dates.
- Until (`end_date`, date): The last day to report on, included. Defaults to the first day. Only when Date range is Between two dates.
- Segment (`segment_id`, text): Only count the data in this segment. Leave empty for all data.
- Only values containing (`search`, text): Only keep values of the dimension that contain this text.
- Sort by first metric (`sort_order`, text): Rank rows by the first metric, highest first unless chosen otherwise. One of: `desc` (Highest first (default)), `asc` (Lowest first).
- Include Unspecified (`include_unspecified`, true/false): Turn on to keep the row Adobe calls Unspecified (no value set).
- Rows (`limit`, number): How many rows to return, 1 to 50000. Defaults to 50. From 1 to 50000.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave to read on. At least 1.

**Outputs**

- `column_errors` (list): Metrics Adobe could not report, with its reason
- `count` (number): How many rows are on this page
- `date_range` (text): The date range as sent to Adobe
- `dimension` (text): The dimension reported by
- `metrics` (list): The metrics reported, in order
- `next_page` (number): The next page's number, or 0 when this is the last
- `page` (number): Which page this is, from 1
- `rows` (list): The rows, ranked
- `total_rows` (number): How many rows the report has in all
- `totals` (object): Each metric's total, by metric id

**Example output**

```json
{
  "column_errors": [],
  "count": 1,
  "date_range": "td-30d/td",
  "dimension": "variables/page",
  "metrics": [
    "metrics/pageviews",
    "metrics/visits"
  ],
  "next_page": 0,
  "page": 1,
  "rows": [
    {
      "data": [
        219567,
        151478
      ],
      "item_id": "3306266643",
      "metrics": {
        "metrics/pageviews": 219567,
        "metrics/visits": 151478
      },
      "value": "home"
    }
  ],
  "total_rows": 1,
  "totals": {
    "metrics/pageviews": 3080619,
    "metrics/visits": 424407
  }
}
```

### Update annotation

Change an annotation's name, dates, color or description. Fields left empty keep their value.

**Inputs**

- Annotation (`annotation_id`, text, required): The annotation. Pick one, or give its id.
- Name (`name`, text): The new name.
- From (`start_date`, date): The new first day.
- Until (`end_date`, date): The new last day. Needs the first day too; defaults to it.
- Color (`color`, text): The annotation's color in reports, one of Adobe's nine. One of: `STANDARD1` (Color 1 (default)), `STANDARD2` (Color 2), `STANDARD3` (Color 3), `STANDARD4` (Color 4), `STANDARD5` (Color 5), `STANDARD6` (Color 6), `STANDARD7` (Color 7), `STANDARD8` (Color 8), `STANDARD9` (Color 9).
- Description (`description`, text): A longer note shown with it.
- Show on every report suite (`apply_to_all_reports`, true/false): Turn on to show the annotation on every report suite, not just this one.

**Outputs**

- `annotation` (object): The annotation as it is now

**Example output**

```json
{
  "annotation": {
    "applyToAllReports": false,
    "color": "STANDARD1",
    "createdDate": "2026-03-23T01:51:28.686Z",
    "dateRange": "2026-03-29T00:00:00/2026-03-29T23:59:59",
    "description": "Homepage banner went live",
    "id": "62437d",
    "modifiedDate": "2026-03-23T01:51:28.686Z",
    "name": "Spring sale launch",
    "owner": {
      "id": 596983,
      "imsUserId": "1B2C3D4E5F6A7B8C9D0E1F2A@AdobeID"
    },
    "reportSuiteName": "Example Suite",
    "rsid": "examplersid",
    "tags": [
      {
        "id": 1,
        "name": "Marketing"
      }
    ]
  }
}
```
