Adobe Analytics

App · 25 actions

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

Actions

ActionWhat it does
Create annotationAdd an annotation to a report suite's reports, marking a day or days such as a launch, a campaign or an outage.
Create segmentCreate a segment of one rule, such as visits where Page contains checkout, for use in reports and virtual report suites.
Delete annotationDelete an annotation, removing it from every report.
Delete segmentDelete a segment, hiding it from everyone.
Get annotationGet one annotation with its dates, color, description and report suite.
Get calculated metricGet one calculated metric with its formula and format.
Get connected userGet the Analytics user this connection acts as: the credential's technical account.
Get metric totalsGet the totals of one or more metrics (such as visits and orders) for a date range, optionally within a segment.
Get projectGet one Analysis Workspace project with who it is shared with, and optionally its full layout of panels and tables.
Get segmentGet one segment with its rules, report suite and owner.
Get top itemsGet the top values of a dimension (the most-viewed pages, the busiest campaigns) between two dates, with Adobe's id for each.
Get trend over timeGet one or more metrics for each hour, day, week, month, quarter or year of a date range, oldest first, optionally within a segment.
List annotationsList annotations (notes on dates in reports, such as a launch or an outage), optionally only those within two dates.
List calculated metricsList calculated metrics with their format, report suite and owner, optionally by name, report suite, favorites or approved ones.
List dimensionsList every dimension a report suite can be reported by (Page, Marketing Channel, eVars and props), with the id a report step takes.
List metricsList every standard metric a report suite has (Page Views, Visits, Orders, events), with the id a report step takes.
List projectsList Analysis Workspace projects with their report suite, owner and when they last changed.
List report suitesList your report suites (the data each site or app collects) with their id, name, currency and time zone.
List saved date rangesList the saved date ranges people use in Workspace, such as Last 6 full weeks, with their rule.
List segmentsList segments with their report suite, owner and when they last changed, optionally by name or report suite.
List usage logsList 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.
List usersList the people who can use Adobe Analytics in your company, with their email and when they last signed in.
List virtual report suitesList virtual report suites (report suites seen through segments) with the report suite each is based on and the segments it applies.
Run reportRun 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.
Update annotationChange an annotation's name, dates, color or description.

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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
NamenametextRequired
The annotation's name, shown on the reports.
Fromstart_datedateRequired
The first day it marks.
Untilend_datedate
The last day it marks. Defaults to the first day.
Colorcolortext
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).
Descriptiondescriptiontext
A longer note shown with it.
Show on every report suiteapply_to_all_reportstrue/false
Turn on to show the annotation on every report suite, not just this one.

Outputs

annotationobject
The new annotation
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
NamenametextRequired
The segment's name.
Keepcontainertext
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).
WheredimensiontextRequired
The dimension the rule looks at, such as Page. Pick a report suite first, or give an id such as variables/page.
Comparisonoperatortext
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).
Valuevaluetext
The text to compare with. Not needed for Has any value or Has no value.
Descriptiondescriptiontext
A longer note shown with it.

Outputs

segmentobject
The new segment
Example output
{
  "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

Annotationannotation_idtextRequired
The annotation. Pick one, or give its id.

Outputs

annotation_idtext
The deleted annotation's id
deletedtrue/false
True once it is deleted
Example output
{
  "annotation_id": "62437d",
  "deleted": true
}

Delete segment

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

Inputs

Segmentsegment_idtextRequired
The segment. Pick one, or give its id.

Outputs

deletedtrue/false
True once it is deleted
segment_idtext
The deleted segment's id
Example output
{
  "deleted": true,
  "segment_id": "s300000022_5bb7c94e80f0073611afb35c"
}

Get annotation

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

Inputs

Annotationannotation_idtextRequired
The annotation. Pick one, or give its id.

Outputs

annotationobject
The annotation
Example output
{
  "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 metriccalculated_metric_idtextRequired
The calculated metric. Pick one, or give its id (it starts with cm).

Outputs

calculated_metricobject
The calculated metric
Example output
{
  "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

userobject
The connected user
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
MetricsmetricslistRequired
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 rangedate_rangetext
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.
Fromstart_datedate
The first day to report on.Only when Date range is Between two dates.
Untilend_datedate
The last day to report on, included. Defaults to the first day.Only when Date range is Between two dates.
Segmentsegment_idtext
Only count the data in this segment. Leave empty for all data.

Outputs

column_errorslist
Metrics Adobe could not report, with its reason
date_rangetext
The date range as sent to Adobe
metricslist
The metrics reported, in order
totalsobject
Each metric's total, by metric id
Example output
{
  "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

Projectproject_idtextRequired
The project. Pick one, or give its id.
Include layoutinclude_definitiontrue/false
Turn on to include the project's panels and tables. It can be large.

Outputs

projectobject
The project
Example output
{
  "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

Segmentsegment_idtextRequired
The segment. Pick one, or give its id.

Outputs

segmentobject
The segment
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
DimensiondimensiontextRequired
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.
Fromstart_datedate
The first day. Leave empty for Adobe's default range.
Untilend_datedate
The last day. Defaults to the first day.
Only values containingsearchtext
Only keep values of the dimension that contain this text.
Include Unspecifiedinclude_unspecifiedtrue/false
Turn on to keep the row Adobe calls Unspecified (no value set).
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
dimensiontext
The dimension read
itemslist
The top values
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
MetricsmetricslistRequired
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.
Eachgranularitytext
How long each period is. Defaults to a day.One of: day (Day (default)), hour, week, month, quarter, year.
Date rangedate_rangetext
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.
Fromstart_datedate
The first day to report on.Only when Date range is Between two dates.
Untilend_datedate
The last day to report on, included. Defaults to the first day.Only when Date range is Between two dates.
Segmentsegment_idtext
Only count the data in this segment. Leave empty for all data.

Outputs

column_errorslist
Metrics Adobe could not report, with its reason
countnumber
How many periods there are
date_rangetext
The date range as sent to Adobe
granularitytext
How long each period is
metricslist
The metrics reported, in order
periodslist
The periods, oldest first
totalsobject
Each metric's total, by metric id
Example output
{
  "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

Whoseincludetext
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, fromstart_datedate
Only annotations that fall entirely on or after this day.
Within, untilend_datedate
And on or before this day. Needs the first day too.
Ordersorttext
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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

annotationslist
The annotations
countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 containsnametext
Only those whose name contains this text.
Report suitersidtext
Only those made in this report suite. Leave empty for all.
Whoseincludetext
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 favoritesfavorites_onlytrue/false
Turn on to list only the connection's favorites.
Only approvedapproved_onlytrue/false
Turn on to list only those an admin approved.
Ordersorttext
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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

calculated_metricslist
The calculated metrics
countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
Only those segments can usesegmentable_onlytrue/false
Turn on to list only those a segment can use.

Outputs

countnumber
How many there are
dimensionslist
The dimensions
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
Only those segments can usesegmentable_onlytrue/false
Turn on to list only those a segment can use.

Outputs

countnumber
How many there are
metricslist
The metrics
Example output
{
  "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

Whoseincludetext
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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
projectslist
The projects
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 containsrsid_containstext
Only report suites whose id contains this text.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
report_suiteslist
The report suites
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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

Whoseincludetext
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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
date_rangeslist
The date ranges
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 containsnametext
Only those whose name contains this text.
Report suitersidtext
Only those made in this report suite. Leave empty for all.
Whoseincludetext
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).
Ordersorttext
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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
segmentslist
The segments
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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

Fromstart_timedate and timeRequired
The earliest time to include.
Untilend_timedate and time
The latest time to include. Defaults to now.
Loginlogintext
Only what this user did, by their Analytics login.
Report suitersidtext
Only what involved this report suite.
Eventeventtext
Only events with exactly this description, such as User logged in.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
logslist
The log entries
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
Example output
{
  "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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
userslist
The users
Example output
{
  "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 onparent_rsidtext
Only those based on this report suite.
Using segmentsegment_idtext
Only those that apply this segment.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

countnumber
How many are on this page
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
totalnumber
How many there are in all, when Adobe says
virtual_report_suiteslist
The virtual report suites
Example output
{
  "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 suitersidtextRequired
The report suite (or virtual report suite) to read. Pick one, or give its id.
DimensiondimensiontextRequired
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.
MetricsmetricslistRequired
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 rangedate_rangetext
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.
Fromstart_datedate
The first day to report on.Only when Date range is Between two dates.
Untilend_datedate
The last day to report on, included. Defaults to the first day.Only when Date range is Between two dates.
Segmentsegment_idtext
Only count the data in this segment. Leave empty for all data.
Only values containingsearchtext
Only keep values of the dimension that contain this text.
Sort by first metricsort_ordertext
Rank rows by the first metric, highest first unless chosen otherwise.One of: desc (Highest first (default)), asc (Lowest first).
Include Unspecifiedinclude_unspecifiedtrue/false
Turn on to keep the row Adobe calls Unspecified (no value set).
Rowslimitnumber
How many rows to return, 1 to 50000. Defaults to 50.From 1 to 50000.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.

Outputs

column_errorslist
Metrics Adobe could not report, with its reason
countnumber
How many rows are on this page
date_rangetext
The date range as sent to Adobe
dimensiontext
The dimension reported by
metricslist
The metrics reported, in order
next_pagenumber
The next page's number, or 0 when this is the last
pagenumber
Which page this is, from 1
rowslist
The rows, ranked
total_rowsnumber
How many rows the report has in all
totalsobject
Each metric's total, by metric id
Example output
{
  "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

Annotationannotation_idtextRequired
The annotation. Pick one, or give its id.
Namenametext
The new name.
Fromstart_datedate
The new first day.
Untilend_datedate
The new last day. Needs the first day too; defaults to it.
Colorcolortext
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).
Descriptiondescriptiontext
A longer note shown with it.
Show on every report suiteapply_to_all_reportstrue/false
Turn on to show the annotation on every report suite, not just this one.

Outputs

annotationobject
The annotation as it is now
Example output
{
  "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"
      }
    ]
  }
}

On this page