curl --request POST \
  --url https://api.geogen.io/v1/domain-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "primaryEntity": "j5712abc34def56ghij7890klmn",
  "entities": [
    "j5712abc34def56ghij7890klmn",
    "j97def56ghij7890klmn5712abc"
  ]
}
'

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "primaryEntityUuid": "<string>",
    "entityTrackingId": "<string>",
    "entities": [
      {
        "entityId": "<string>",
        "entityUuid": "<string>",
        "name": "<string>",
        "target": "<string>",
        "faviconUrl": "<string>",
        "isPrimary": true,
        "inWorkspace": true
      }
    ],
    "createdAt": 123,
    "updatedAt": 123
  },
  "message": "<string>"
}

Domain Groups

Create Domain Group

Create a domain group that merges analytics for multiple entities representing the same brand.

Entity references in primaryEntity and entities may be either:

an entityId returned by GET /v1/entities (a tracking ID for an entity in this workspace), or
an entity UUID returned as entityUuid by GET /v1/competitors (any entity in the system).

At least 2 entities are required, and primaryEntity must be included in the entities array. Each entity may belong to at most one group at a time. Additional non-primary entities count toward your workspace entity limit.

POST

domain-groups

curl --request POST \
  --url https://api.geogen.io/v1/domain-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "primaryEntity": "j5712abc34def56ghij7890klmn",
  "entities": [
    "j5712abc34def56ghij7890klmn",
    "j97def56ghij7890klmn5712abc"
  ]
}
'

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "primaryEntityUuid": "<string>",
    "entityTrackingId": "<string>",
    "entities": [
      {
        "entityId": "<string>",
        "entityUuid": "<string>",
        "name": "<string>",
        "target": "<string>",
        "faviconUrl": "<string>",
        "isPrimary": true,
        "inWorkspace": true
      }
    ],
    "createdAt": 123,
    "updatedAt": 123
  },
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication. Format: Bearer wsk_your_api_key

Body

application/json

primaryEntity

string

required

The primary entity reference (entityId or entity UUID). Its name/favicon represent the group in the UI.

entities

string[]

required

Array of 2+ entity references (entityIds or entity UUIDs). Must include the primary entity.

Minimum array length: 2

name

string

Display name for the group. Defaults to the primary entity's name when omitted.

entityId

string

Optional. When provided, scopes the group to this entity tracking. Only analytics generated under this tracking will be merged.

Response

Domain group created successfully.

success

boolean

data

object

A group of entities that represent the same brand. Analytics for grouped entities are merged across all pages and responses.

Show child attributes

message

string

List Domain Groups Update Domain Group

Documentation Index

Authorizations

Body

Response