Goal

Schema, including its fields, nested structure, and relationships

Definition

A Goal defines a conversion or behavioral outcome to measure (e.g., an event name or a screen view). Goals can be attached to campaigns (if supported) and are used for reporting/attribution.

Payload Properties

When creating or updating a goal, the payload can include:

• id (String, optional) – The goal's unique ID. Include this only when updating an existing goal.
• type (String, required) — Goal category. Common values: "screenview", "event", "transaction".
• label (String, required) — Identifier for the goal (e.g., screen name or event label).
• operator (String, required) — Comparison operator. Examples: "equals", "contains", "regex".
• value (String, required) — Value to match against (e.g., "Performance").

Notes • Goals may be referenced by campaigns via goal_ids (if supported by your schema). • The analytics pipeline attributes conversions that match (type, operator, value) against user activity.

Example Project Payload:

{
  "type": "screenview",
  "label": "goal_created_with_resource_loader",
  "operator": "contains",
  "value": "Performance"
}

Response Fields

When a Goal is returned by the API/Resource Loader, you’ll receive its server-assigned ID and the normalized definition:

• id (String) — Unique goal identifier.
• type (String) — Goal category (e.g., "screenview").
• label (String) — Goal label/identifier.
• operator (String) — Comparison operator.
• value (String) — Comparison value.

Example Project Response:

{
  "id": "goal_id",
  "label": "goal_created_with_resource_loader",
  "operator": "contains",
  "type": "screenview",
  "value": "Performance"
}

Error Codes

• InvalidPayload – Missing project name when creating a project, or other payload formatting issues.
• PermissionDenied – User not allowed to create projects (if such permission is restricted).