Google Analytics · Schema

Goals

A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name Type Description
items array A list of goals.
itemsPerPage integer The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified
kind string Collection type.
nextLink string Link to next page for this goal collection.
previousLink string Link to previous page for this goal collection.
startIndex integer The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
totalResults integer The total number of results for the query, regardless of the number of resources in the result.
username string Email ID of the authenticated user
View JSON Schema on GitHub

JSON Schema

google-analytics-goals-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Goals",
  "title": "Goals",
  "description": "A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.",
  "properties": {
    "items": {
      "description": "A list of goals.",
      "items": {
        "$ref": "#/components/schemas/Goal"
      },
      "type": "array"
    },
    "itemsPerPage": {
      "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
      "format": "int32",
      "type": "integer"
    },
    "kind": {
      "default": "analytics#goals",
      "description": "Collection type.",
      "type": "string"
    },
    "nextLink": {
      "description": "Link to next page for this goal collection.",
      "type": "string"
    },
    "previousLink": {
      "description": "Link to previous page for this goal collection.",
      "type": "string"
    },
    "startIndex": {
      "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
      "format": "int32",
      "type": "integer"
    },
    "totalResults": {
      "description": "The total number of results for the query, regardless of the number of resources in the result.",
      "format": "int32",
      "type": "integer"
    },
    "username": {
      "description": "Email ID of the authenticated user",
      "type": "string"
    }
  },
  "type": "object"
}