Manage team lists

Team lists are user-defined, centralized lists, that can be used in queries to reference a list of saved values.

{"ds_accounts": "list.my_list_slug"}

• List team lists
• Get team list
• Add team list
• Update team list
• Remove team list
• Get list data for account IDs
• Set list data for account IDs
• Built-in lists
• Supported types
• Supported products
• Object reference
• Errors

List team lists

Response

HTTP 200 OK
{
    "meta": {
        "request_id": "WnjTGeKqOXTnkZQMbZCfVMdmswv2wAzx"
    },
    "data": [
        {
            "list_id": "tml_1",
            "list_slug": "my_list_slug",
            "list_name": "My list of accounts",
            "list_type": "account_ids",
            "ds_id": "",
            "ds_name": "",
            "show_in_products": [
                "API"
            ]
        },
        {
            "list_id": "tml_2",
            "list_slug": "my_list_slug",
            "list_name": "My list of accounts for Google Analytics",
            "list_type": "account_ids",
            "ds_id": "GA",
            "ds_name": "Google Analytics",
            "show_in_products": [
                "API"
            ]
        }
    ]
}

Permissions

team_lists_read

Get team list

• list_id string
  Supermetrics team list ID

Response

HTTP 200 OK
{
    "meta": {
        "request_id": "WnjTGeKqOXTnkZQMbZCfVMdmswv2wAzx"
    },
    "data": {
        "list_id": "tml_2",
        "list_slug": "my_list_slug",
        "list_name": "My list of accounts for Google Analytics",
        "list_type": "account_ids",
        "ds_id": "GA",
        "ds_name": "Google Analytics",
        "show_in_products": [
            "API"
        ]
    }
}

Errors

LIST_NOT_FOUND

Permissions

team_lists_read

Add team list

• list_slug string
  Required. User-defined ID, used to reference list in queries. Restricted to characters A-Z, a-z, 0-9 and _.
• list_name string
  Required. List name, used in product UI.
• list_type string
  Required. List type, see supported types for more.
• ds_id string
  Optional. Data source ID. See data sources for more. If not provided or an empty string, list is global, and available for all data sources.
• show_in_products string | string[]
  Optional. List of Supermetrics products this list should be shown in. If not provided or an empty list, not shown in any product.

Request

POST https://api.supermetrics.com/enterprise/v2/team/list
Authorization: Bearer <your api key>
Content-Type: application/json

{
    "list_slug": "my_list_slug",
    "list_name": "My List Name",
    "list_type": "account_ids",
    "ds_id": "GA",
    "show_in_products": "API"
}

Response

Errors

LIST_CREATE_FAILED, LIST_SLUG_EXISTS, LIST_SLUG_INVALID, LIST_SLUG_RESERVED

Permissions

team_lists_write

Update team list

• list_name string
  Required. List name, used in product UI.
• show_in_products string | string[]
  Optional. List of Supermetrics products this list should be shown in. If not provided or an empty list, not shown in any product.

Request

PATCH https://api.supermetrics.com/enterprise/v2/team/list/tml_2
Authorization: Bearer <your api key>
Content-Type: application/json

{
    "show_in_products": "API, DWH"
}

Response

Errors

LIST_NOT_FOUND, LIST_UPDATE_FAILED

Permissions

team_lists_write

Remove team list

• link_id string
  Supermetrics team list ID

Response

204 No Content

Errors

LIST_NOT_FOUND, LIST_UPDATE_FAILED

Permissions

team_lists_write

Get list data for account IDs

This endpoint applies only to list type account_ids.

• list_id string
  Supermetrics team list ID

Response

HTTP 200 OK
{
    "meta": {
        "request_id": "WnjTGeKqOXTnkZQMbZCfVMdmswv2wAzx"
    },
    "data": "Database\nFacebook Public Data\nGoogle+ Public Data\nInstagram\n"
}

Errors

LIST_NOT_FOUND

Permissions

team_lists_read

Set list data for account IDs

This endpoint applies only to list type account_ids.

• list_id string
  Supermetrics team list ID
• data string
  Required. List source data, where values are separated by line feeds. Data for query runtime is stored with trimmed and deduplicated values. When case-insensitive duplicates are found, first value is kept.

Request

PUT https://api.supermetrics.com/enterprise/v2/team/list/tml_2/data/account_ids
Authorization: Bearer <your api key>
Content-Type: application/json

{
    "data": "Database\nFacebook Public Data\nGoogle+ Public Data\nInstagram\n"
}

Response

204 No Content

Permissions

team_lists_write

Built-in lists

The following team lists are automatically available, and their names are reserved for system use.

Supported types

Team list behaviour depends on the list type.

account_ids

Data source account ID values. This list can appear in the account selection UI for selected Supermetrics products.

Query parameters

List can be referenced in queries as an account, by using the slug name and a list.-prefix. If multiple lists are found, data source specific one is preferred.

{"ds_accounts": "list.my_list_slug"}

Data endpoints

• Get list data for account IDs
• Set list data for account IDs

Supported products

Object reference

team_list

Errors