Workspaces: getStatus

Stay organized with collections Save and categorize content based on your preferences.

Finds conflicting and modified entities in the workspace. Try it now.

Request

HTTP request

GET https://www.googleapis.com/tagmanager/v2/+path/status

Parameters

Parameter name Value Description
Path parameters
path string GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Authorization

This request requires authorization with at least one of the following scopes:

Scope
https://www.googleapis.com/auth/tagmanager.edit.containers
https://www.googleapis.com/auth/tagmanager.readonly

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "workspaceChange": [
    {
      "tag": accounts.containers.workspaces.tags Resource,
      "trigger": accounts.containers.workspaces.triggers Resource,
      "variable": accounts.containers.workspaces.variables Resource,
      "folder": accounts.containers.workspaces.folders Resource,
      "client": accounts.containers.workspaces.clients Resource,
      "changeStatus": string
    }
  ],
  "mergeConflict": [
    {
      "entityInWorkspace": {
        "tag": accounts.containers.workspaces.tags Resource,
        "trigger": accounts.containers.workspaces.triggers Resource,
        "variable": accounts.containers.workspaces.variables Resource,
        "folder": accounts.containers.workspaces.folders Resource,
        "client": accounts.containers.workspaces.clients Resource,
        "changeStatus": string
      },
      "entityInBaseVersion": {
        "tag": accounts.containers.workspaces.tags Resource,
        "trigger": accounts.containers.workspaces.triggers Resource,
        "variable": accounts.containers.workspaces.variables Resource,
        "folder": accounts.containers.workspaces.folders Resource,
        "client": accounts.containers.workspaces.clients Resource,
        "changeStatus": string
      }
    }
  ]
}
Property name Value Description Notes
workspaceChange[] list Entities that have been changed in the workspace.
workspaceChange[].tag nested object The tag being represented by the entity.
workspaceChange[].trigger nested object The trigger being represented by the entity.
workspaceChange[].variable nested object The variable being represented by the entity.
workspaceChange[].folder nested object The folder being represented by the entity.
workspaceChange[].changeStatus string Represents how the entity has been changed in the workspace.

Acceptable values are:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[] list The merge conflict after sync.
mergeConflict[].entityInWorkspace nested object The workspace entity that has conflicting changes compared to the base version. If an entity is deleted in a workspace, it will still appear with a deleted change status.
mergeConflict[].entityInWorkspace.tag nested object The tag being represented by the entity.
mergeConflict[].entityInWorkspace.trigger nested object The trigger being represented by the entity.
mergeConflict[].entityInWorkspace.variable nested object The variable being represented by the entity.
mergeConflict[].entityInWorkspace.folder nested object The folder being represented by the entity.
mergeConflict[].entityInWorkspace.changeStatus string Represents how the entity has been changed in the workspace.

Acceptable values are:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
mergeConflict[].entityInBaseVersion nested object The base version entity (since the latest sync operation) that has conflicting changes compared to the workspace. If this field is missing, it means the workspace entity is deleted from the base version.
mergeConflict[].entityInBaseVersion.tag nested object The tag being represented by the entity.
mergeConflict[].entityInBaseVersion.trigger nested object The trigger being represented by the entity.
mergeConflict[].entityInBaseVersion.variable nested object The variable being represented by the entity.
mergeConflict[].entityInBaseVersion.folder nested object The folder being represented by the entity.
mergeConflict[].entityInBaseVersion.changeStatus string Represents how the entity has been changed in the workspace.

Acceptable values are:
  • "added"
  • "changeStatusUnspecified"
  • "deleted"
  • "none"
  • "updated"
workspaceChange[].client nested object The client being represented by the entity.
mergeConflict[].entityInWorkspace.client nested object The client being represented by the entity.
mergeConflict[].entityInBaseVersion.client nested object The client being represented by the entity.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.