Supermetrics

https://docs.supermetrics.com/docs
Admin
Supermetrics is a data connector platform that enables marketers to pull data from multiple...
Tokens:338,119
Snippets:6,039
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Full connector configuration example

Source: https://docs.supermetrics.com/docs/tutorial-for-your-first-connector

A complete example showing the integration of authentication user inputs and the dataSourceUser configuration.

```json
{
 		"$schema": "https://api.supermetrics.com/cc/v1/schema/connector",
 		"authentication": {
 				"type": "user_input",
 				"description": "Please provide your API key for News API, and give a lable for they key so you can identify it later.",
 				"userInputs": [
 						{
 								"id": "api_key",
 								"label": "API key",
 								"type": "password"
 						},
 						{
 								"id": "label",
 								"label": "Label",
 								"type": "text"
 						}
 				]
 		},
 		"dataSourceUser": {
 				"userInfo": {
 						"id": {
 								"source": "static",
 								"value": "{{identity()}}"
 						},
 						"accessToken": {
 								"source": "userInput",
 								"value": "api_key"
 						},
 						"label": {
 								"source": "userInput",
 								"value": "label"
 						}
 				}
 		}
}
```

--------------------------------

### Configure request object for user info

Source: https://docs.supermetrics.com/docs/data-source-user

Example configuration for a GET request to fetch user profile information automatically upon authentication.

```json
"dataSourceUser": {
    "request": {
      "method": "GET",
      "url": "https://api.spotify.com/v1/me",
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer {{user.access_token}}"
        }
      ],
      "response": {
        "type": "JSON",
        "dataRows": {
          "source": "jsonPath",
          "value": "$"
        }
      }
    }
}
```

--------------------------------

### Complete product page implementation example

Source: https://docs.supermetrics.com/docs/how-to-set-up-web-tracking-and-event-collection

A full example demonstrating the sequence of setting environment, structure, properties, and triggering the load.

```javascript
_st('setEnvironment', 'test');
_st('setPageStructure', 'product|details');
_st('addTagProperties', { country: 'fi', language: 'sv' });
_st('loadTags');
```

--------------------------------

### Original keyed response example

Source: https://docs.supermetrics.com/docs/append-key

An example of a JSON response keyed by date before the adapter is applied.

```json
{
  "2022-11-27": {
    "nb_uniq_visitors": 1203,
    "nb_users": 28
  },
  "2022-11-28": {
    "nb_uniq_visitors": 1029,
    "nb_users": 60
  }
}
```

--------------------------------

### X (Twitter) connector batching example

Source: https://docs.supermetrics.com/docs/joining-data

Annotated example showing tweet rows joined with engagement details in batches of 20.

```json
"decoration": {
  "relations": [
    {
      "reportTypeId": "details",
      "type": "inverse",
      "includeMetrics": true,
      "useDates": true,
      "link": {
        "parent": "tweet_id",
        "child": "tweet_id"
      },
      "batching": {
        "isEnabled": true,
        "batchSize": 20
      }
    }
  ]
}
```

--------------------------------

### Spotify API Account Response Example

Source: https://docs.supermetrics.com/docs/accounts

Example JSON response from the Spotify Ads API containing a list of ad accounts.

```json
{
 	"ad_accounts": [
 		{
 			"id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",
 			"business_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",
 			"created_at": "2026-01-23T04:56:07Z",
 			"updated_at": "2026-01-23T04:56:07Z",
 			"country_code": "US",
 			"industry": "Media & Entertainment",
 			"website": "https://www.spotify.com",
 			"billing_address": {
 				"name": "Entity_1",
 				"street": "123 Spotify Avenue",
 				"city": "Los Angeles",
 				"region": "California",
 				"postal_code": "90210",
 				"tax_region": "ES"
 			},
 			"legal_entity_name": "Spotify AB",
 			"status": "ACTIVE",
 			"status_reason": "string",
 			"name": "Nike SB",
 			"ad_account_role": "AD_ACCOUNT_ADMIN",
 			"tax_id": "ATU82660371",
 			"currency_code": "USD"
 		}
 	]
 }
```

--------------------------------

### GET /t-{t}

Source: https://docs.supermetrics.com/docs/data-activation-tracking-api-endpoints

Collects session information for data exports and session starts.

```APIDOC
## GET /t-{t}

### Description
Collects session information for data exports and session starts.

### Method
GET

### Endpoint
https://t.svtrd.com/t-{t}

### Parameters
#### Path Parameters
- **t** (string) - Required - Your site ID.

#### Query Parameters
- **i** (string) - Required - The UUID.
- **u** (string) - Required - The URL of the current page.
- **s** (string) - Required - The referrer URL.
- **p** (boolean) - Required - Pageview flag.
- **pn** (boolean) - Required - A flag indicating whether this is the start of a session.
- **cb** (number) - Required - A randomly generated cache buster.
```

--------------------------------

### Relative date format examples

Source: https://docs.supermetrics.com/docs/about-custom-date-ranges-in-google-sheets

Commonly used relative date strings for the Start and End date fields in the Supermetrics sidebar.

```text
yesterday
```

```text
today
```

```text
-x days, replacing x with a number of days
```

--------------------------------

### Adapter configuration example

Source: https://docs.supermetrics.com/docs/combine-keys-with-values

Configuration block defining the keysPath, valuesPath, and dataDestinationPath for the adapter.

```json
"response": {
  "dataRows": {
    "source": "jsonPath",
    "value": "$.rows.*"
  },
  "dataAdapters": {
    "items": [
      {
        "type": "combine_keys_with_values",
        "config": {
          "keysPath": "$.headers.*",
          "valuesPath": "$.rows.*.values",
          "dataDestinationPath": "$.rows"
        }
      }
    ]
  }
}
```

--------------------------------

### Configure userInfo from user inputs

Source: https://docs.supermetrics.com/docs/data-source-user

Example configuration where user information is sourced from authentication inputs.

```json
  "dataSourceUser": {
    "userInfo": {
      "id": {
        "source": "static",
        "value": "{{identity()}}"
      },
      "label": {
        "source": "userInput",
        "value": "account_name"
      },
      "accessToken": {
        "source": "userInput",
        "value": "api_key"
      }
    }
  }
```

--------------------------------

### Field Definition Example

Source: https://docs.supermetrics.com/docs/split-to-rows

Example field definitions for accessing the transformed data structure.

```json
[
  {
    "id": "value",
    "label": "Value",
    "dataType": "string.text.value",
    "value": {
      "source": "jsonPath",
      "value": "$.someNewPropKey"
    }
  }
]
```

--------------------------------

### Set Environment

Source: https://docs.supermetrics.com/docs/about-st-async-module

Selects the environment for tag-loading, defaulting to 'prod'.

```javascript
_st('setEnvironment', 'test');
```

--------------------------------

### Get mappings for a profile

Source: https://docs.supermetrics.com/docs/data-activation-api-documentation

Retrieve all ID mappings for a specific user profile using a GET request.

```powershell
curl -X GET --header 'Accept: application/json' \

  'https://api.relay42.com/v1/<SiteID>/profiles/<partnerType>/mappings?partnerId=<partnerId>'
```

--------------------------------

### JSON Input Example

Source: https://docs.supermetrics.com/docs/split-to-rows

The initial state of the data before the split_to_rows adapter is applied.

```json
{
  "result": {
    "someProperty": "foo",
    "theImportantProperty": "123123,456456,789789"
  }
}
```

--------------------------------

### Basic adapter configuration

Source: https://docs.supermetrics.com/docs/union-nested-arrays-with-key

Standard configuration to union all categories found within the container path.

```json
"response": {
  "dataRows": {
    "source": "jsonPath",
    "value": "$.data.*"
  },
  "dataAdapters": {
    "items": [
      {
        "type": "union_nested_arrays_with_key",
        "config": {
          "dataPath": "$.data.*",
          "containerPath": "$.messages",
          "keyName": "channel_type"
        }
      }
    ]
  }
}
```

--------------------------------

### Configure Connector Fields

Source: https://docs.supermetrics.com/docs/reporting

Example structure for defining dimensions and metrics groups within a connector configuration.

```json
 {
 		"dimensions": {
 			"groups": [
 				{
 					"label": "DIMENSIONS",
 					"fields": [
 						{
 							"id": "campaign_id",
 							"label": "Campaign ID",
 							"dataType": "string.text.value",
 							"value": {
 								"source": "jsonPath",
 								"value": "$.campaign_id"
 							}
 						}
 					]
 				}
 			]
 		},
 		"metrics": {
 			"groups": [
 				{
 					"label": "METRICS",
 					"fields": [
 						{
 							"id": "impressions",
 							"label": "Impressions",
 							"dataType": "int.number.value",
 							"value": {
 								"source": "jsonPath",
 								"value": "$.impressions"
 							},
 							"aggregationType": "sum"
 						}
 					]
 				}
 			]
 		}
 }
```

--------------------------------

### Get ID mappings for a specific partner

Source: https://docs.supermetrics.com/docs/data-activation-api-documentation

Retrieve a list of IDs mapped to a profile for a specific partner using a GET request.

```powershell
curl -X GET --header 'Accept: application/json' \

  'https://api.relay42.com/v1/<SiteID>/profiles/<partnerType>/mappings/<mappingPartnerType>?partnerId=<partnerId>'
```

--------------------------------

### _st('setEnvironment', environment)

Source: https://docs.supermetrics.com/docs/base-script-configuration-reference

Select the environment for tag loading. Defaults to prod.

```APIDOC
## _st('setEnvironment', environment)

### Description
Select the environment for tag loading. Defaults to prod.

### Parameters
- **environment** (string) - Required - The environment name (e.g., 'test').
```

--------------------------------

### Time series adapter configuration

Source: https://docs.supermetrics.com/docs/time-series

Example configuration for the time_series adapter, defining paths for data, metrics, and time parameters.

```json
"response": {
  "dataRows": {
    "source": "jsonPath",
    "value": "$.data.*.id_data.*"
  },
  "dataAdapters": {
    "items": [
      {
        "type": "time_series",
        "config": {
          "dataPath": "$.data.*",
          "valuesPath": "$.id_data.0.metrics",
          "startTimePath": "$.request.params.start_time",
          "endTimePath": "$.request.params.end_time",
          "granularity": {
            "source": "jsonPath",
            "value": "$.request.params.granularity"
          },
          "dataDestinationPath": "$.id_data",
          "keyName": "date"
        }
      }
    ]
  }
}
```
Tokens:
Raw