Skip to content
telipot
telipot
Join the waitlistSign in

Dimensions and metrics a property offers, with custom ones.

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.

Job analytics.properties.metadata

Your AI asks

checks the price first
telipot run google-analytics.properties.metadata \
  --input-json '{"propertyId":"123456789"}' \
  --quote

Price

Free
Priced· before it runs

google-analytics.properties.metadata

FreeCompany account

Whose account it uses

1The person asking
skipped
2Your company’s Google Analytics 4 account
Selected identity for this example
3Our account
not used

What it sends

{
  "propertyId": "123456789"
}

Your Google Analytics 4 login is added for you. Your AI never sees it.

What it costs

Free

no charge from the provider

Preview the price first. --quote runs nothing.

For developers · run it

Shell · runs the task on the named account

telipot run google-analytics.properties.metadata \
  --input-json '{"propertyId":"123456789"}'

propertyId

string · required

The numeric id of a GA4 property, as google-analytics.accounts.summaries returns it after properties/; 0 lists only the dimensions and metrics common to every property

name

string

The resource name, properties/<id>/metadata

dimensions

object[]

metrics

object[]

Full output schema · JSONNested fields and constraints

Output JSON Schema

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name, properties/<id>/metadata"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string",
            "description": "The name a report request uses"
          },
          "uiName": {
            "type": "string",
            "description": "The name Google Analytics shows"
          },
          "description": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "customDefinition": {
            "type": "boolean",
            "description": "True for a custom dimension"
          },
          "deprecatedApiNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "metrics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string",
            "description": "The name a report request uses"
          },
          "uiName": {
            "type": "string",
            "description": "The name Google Analytics shows"
          },
          "description": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "description": "The kind of value such as TYPE_INTEGER"
          },
          "expression": {
            "type": "string",
            "description": "The formula of a derived metric"
          },
          "customDefinition": {
            "type": "boolean",
            "description": "True for a custom metric"
          },
          "deprecatedApiNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "blockedReasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

A real answer

examples/google-analytics.properties.metadata.json

{
  "name": "properties/123456789/metadata",
  "dimensions": [
    {
      "apiName": "country",
      "uiName": "Country",
      "description": "The country the user activity came from.",
      "category": "Geography",
      "customDefinition": false
    },
    {
      "apiName": "customEvent:levels_unlocked",
      "uiName": "levels_unlocked",
      "description": "A custom event parameter.",
      "category": "Custom",
      "customDefinition": true
    }
  ],
  "metrics": [
    {
      "apiName": "activeUsers",
      "uiName": "Active users",
      "description": "The number of distinct users who visited the site or app.",
      "category": "User",
      "type": "TYPE_INTEGER",
      "customDefinition": false
    },
    {
      "apiName": "eventCount",
      "uiName": "Event count",
      "description": "The number of events.",
      "category": "Event",
      "type": "TYPE_INTEGER",
      "customDefinition": false
    }
  ]
}