Skip to main content
Glama

analyticsdata.properties.audienceExports.get

Retrieves configuration metadata for an audience export by resource name, letting you inspect its setup after creation.

Instructions

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See Creating an Audience Export for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https: [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, list, query.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.

Output Schema

NameRequiredDescriptionDefault
nameNo
stateNo
audienceNo
rowCountNo
dimensionsNo
errorMessageNo
beginCreatingTimeNo
audienceDisplayNameNo
percentageCompletedNo
creationQuotaTokensChargedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`"New value: +"[URL path segment] Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`"
    • addedInput schema / properties / name / pattern
      Added value: +"^properties/[^/]+/audienceExports/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "audience": {
      +      "type": "string"
      +    },
      +    "audienceDisplayName": {
      +      "type": "string"
      +    },
      +    "beginCreatingTime": {
      +      "type": "string"
      +    },
      +    "creationQuotaTokensCharged": {
      +      "type": "integer"
      +    },
      +    "dimensions": {
      +      "items": {
      +        "properties": {
      +          "dimensionName": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "errorMessage": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "percentageCompleted": {
      +      "type": "number"
      +    },
      +    "rowCount": {
      +      "type": "integer"
      +    },
      +    "state": {
      +      "enum": [
      +        "STATE_UNSPECIFIED",
      +        "CREATING",
      +        "ACTIVE",
      +        "FAILED"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden. It discloses that this is an HTTP GET returning the resource as JSON (implying read-only) and notes alpha/beta stability, which is useful context. It does not mention permission requirements or rate limits, and a broken link ('(https:') undercuts the reference material.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The front-loaded purpose sentence is good, but the body drags in API stability policy and feedback-request prose that do not help an agent select or invoke the tool, and one link is truncated. Signal-to-noise is poor for a simple get operation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and schema coverage is complete, so return values and the single key parameter are covered elsewhere. The description is adequate for a read-only get, but the padding and missing auth/permission notes keep it from being fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the `name` parameter and its format are already documented. The description adds the typed-params-vs-`params`-map-vs-`body_file` precedence rule, which adds some meaning, but this is generic request-construction boilerplate rather than specifics about the audience export resource.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Gets configuration metadata about a specific audience export,' and the closing sentence names the sibling operations (create, list, query) over the same resource. This lets an agent distinguish it from query/list without opening schemas, though it does not contrast get-vs-query behavior explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Can be used to understand an audience export after it has been created' implies a usage context, and a pointer to the Creating an Audience Export doc is given. However, there is no explicit when-to-use vs when-to-use-query guidance or any exclusions, leaving routing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools