# Meta Dataset Quality Import Integration

Advertisers that share server events using the Conversions API can see the event match quality score in Meta Events Manager. However, this only works on an individual basis and is difficult to scale in cases where a tech provider partner, agency partner or advertiser is managing hundreds and thousands of Meta Pixels for their businesses. The Dataset Quality (formerly known as Integration Quality) API can help solve this problem by consolidating dataset quality metrics programmatically at scale.

This connector will help customer import the metrics for the Conversions API, including event match quality, event coverage, event deduplication, additional conversions reported.

# Requirements and Limitations

- Have a basic knowledge about the Treasure Data
- Have a basic knowledge about the Meta Conversion
- Have the Meta access token and dataset id (Ref this page for more detail https://developers.facebook.com/docs/marketing-api/conversions-api/dataset-quality-api)


## Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
[https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/](https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/)

## Usecase

Ex.1 Match Key Coverage by Dataset

The heatmap below illustrates coverage rates (%) of different match keys (such as email, phone, external_id, fbp, fbc) across multiple datasets.

- Rows: Match keys (the identifiers used for event matching)
- Columns: Dataset IDs (representing different integration sources or campaigns)
- Cells: Coverage percentage — i.e., the share of events in that dataset containing the specific match key


![](/assets/output.9c5876adbce9b4892c627fbd8acf5993aa685d831608026d4a80177122015910.5f26d108.png)

How to use this dashboard:

- Identify weak match keys in each dataset (e.g., dataset_B shows low coverage for phone).
- Prioritize improvements in match keys with the biggest gap across datasets, since higher coverage directly improves Event Match Quality (EMQ).
- Use this view together with EMQ trends and deduplication stats to build a complete picture of dataset quality.


# Import from Meta Dataset via TD Console

## Create Authentication

Your first step is to create a new authentication with a set of credentials.

1. Select **Integrations Hub**.
2. Select **Catalog**.
![](/assets/integrationshub-catalog2.e33c0a4c7d81c40cc83dd056c2143b97b1406220e213cab14ef349d69412ffef.7705d4c2.png)
3. Search for your Integration in the Catalog; hover your mouse over the icon and select **Create Authentication**.
![](/assets/26617501.d6a5ad453f9fa98b4336af9506dadbd04ea44299e2f9af7fd760f75ac68e3f88.25ec5a77.png)
4. Ensure that the **Credentials** tab is selected and then enter credential information for the integration.


### **OAuth Authentication**

| Parameter | Description |
|  --- | --- |
| Authentication Method | OAuth Authentication method |


![](/assets/screenshot-2025-08-05-at-14.36.31.f70e373307117e54096d66c28e2047c2334dbbf310b3c938f9c3207c7ae89f2b.5f26d108.png)

Click on the link Click here to start the OAuth authentication, after login with Facebook successfully, it will redirect to the TD console website then click on the Continue button

#### **Access Token Authentication**

![](/assets/screenshot-2025-08-05-at-14.41.04.74927942e3c1d30853178b61180a50593db3ceb2bf4bd74ce2e8e3355d6b2422.5f26d108.png)

| Parameter | Description |
|  --- | --- |
| Authentication | Access Token Authentication method |
| Access Token | Meta Access Token |
| App Secret | Meta App Secret |


1. Enter a name for your authentication and select **Done**.


## Create a Source

1. Open TD Console.
2. Navigate to **Integrations Hub** > **Authentications**.
3. Locate your new authentication and select **New Source**.


## Create a Connection

| Parameter | Description |
|  --- | --- |
| Data Transfer Name | You can enter the name of your transfer. |
| Authentication | The authentication name that is used for a transfer. |


1. Type a source name in the Data Transfer Name field.
2. Select **Next**.


The Create Source page displays with the **Source Table** tab selected.

## Identify a Source Table

![](/assets/screenshot-2025-08-06-at-15.15.05.aba984cabb5d2dc21cd88832c2b5b0cac89da10bc9a179c886434f39a381fae6.5f26d108.png)

| Parameter | Description |
|  --- | --- |
| Dataset ID | The ID of dataset (Pixel) to retrieve quality data. |
| Agent Name | The normalized value of the partner_agent field is used to filter only events sent with partner_agent |
| Event Type | The type of event. Currently supported only website event. |
| Website Metric Type | The metric of event for website and supported following values  - Event Match Quality - Additional Conversions Reported for Parameters - Event Match Quality Diagnostics - Event Coverage - Additional Conversions Reported for Event Coverage - Event Deduplication - Data Freshness - Additional Conversions Reported for Event - Additional Conversions Reported |


Select **Next**.

## Define Data Settings

![](/assets/screenshot-2025-08-06-at-15.16.13.0d48d6df80ba3a5e798f9d708b696415bb6c806b9b326f56ccd3c41f9ffcb65f.5f26d108.png)

| Parameter | Description |
|  --- | --- |
| Retry Limit | The maximum retry limit. |
| Initial Retry Wait | The time await for the first retry in seconds. |
| Maximum Retry Wait | The maximum time for the retry in seconds. |
| HTTP Connection Timeout | The timeout connection setting in seconds. |
| HTTP Read Timeout | The read timeout setting in seconds. |


Select **Next**.

### Data Preview

You can see a [preview](/products/customer-data-platform/integration-hub/batch/import/previewing-your-source-data) of your data before running the import by selecting Generate Preview. Data preview is optional and you can safely skip to the next page of the dialog if you choose to.

1. Select **Next**. The Data Preview page opens.
2. If you want to preview your data, select **Generate Preview**.
3. Verify the data.


### Data Placement

For data placement, select the target database and table where you want your data placed and indicate how often the import should run.

1. Select **Next.** Under Storage, you will create a new or select an existing database and create a new or select an existing table for where you want to place the imported data.
2. Select a **Database** > **Select an existing** or **Create New Database**.
3. Optionally, type a database name.
4. Select a **Table**> **Select an existing** or **Create New Table**.
5. Optionally, type a table name.
6. Choose the method for importing the data.
  - **Append** (default)-Data import results are appended to the table.
If the table does not exist, it will be created.
  - **Always Replace**-Replaces the entire content of an existing table with the result output of the query. If the table does not exist, a new table is created.
  - **Replace on New Data**-Only replace the entire content of an existing table with the result output when there is new data.
7. Select the **Timestamp-based Partition Key** column.
If you want to set a different partition key seed than the default key, you can specify the long or timestamp column as the partitioning time. As a default time column, it uses upload_time with the add_time filter.
8. Select the **Timezone** for your data storage.
9. Under **Schedule**, you can choose when and how often you want to run this query.


#### Run once

1. Select **Off**.
2. Select **Scheduling Timezone**.
3. Select **Create & Run Now**.


#### Repeat Regularly

1. Select **On**.
2. Select the **Schedule**. The UI provides these four options: *@hourly*, *@daily* and *@monthly* or custom *cron*.
3. You can also select **Delay Transfer** and add a delay of execution time.
4. Select **Scheduling Timezone**.
5. Select **Create & Run Now**.


After your transfer has run, you can see the results of your transfer in **Data Workbench** > **Databases.**

# Import from Meta Dataset via Workflow

You can import data from Meta Dataset by using td_load>: operator of workflow. If you have already created a SOURCE, you can run it; if you don't want to create a SOURCE, you can import it using a yml file.

## Using a Source

1. Identify your source.
2. To obtain a unique ID, open the Source list and then filter by Meta Dataset Quality.
3. Open the menu and select **Copy Unique ID**.


![](/assets/26617502.09d9b84b0f1f752c7c95b0bc1c2d8e8b7302e5b91c6a3cb5f01309dadf53a604.25ec5a77.png)

1. Define a workflow task using td_load> operator.



```yaml
+load:
  td_load>: unique_id_of_your_source
  database: ${td.dest_db}
  table: ${td.dest_table}
```

1. Run a workflow.


## Using a yml file

1. Identify your yml file. If you need to create the yml file, review [Amazon S3 Import Integration Using CLI](https://docs.treasuredata.com/display/INT/Amazon+S3+Import+Integration+Using+CLI) for reference.
2. Define a workflow task using td_load> operator.



```yaml
+load:
  td_load>: config/daily_load.yml
  database: ${td.dest_db}
  table: ${td.dest_table}
```

1. Run a workflow


### Parameters Reference

| Name | Description | Value | Default Value | Required |
|  --- | --- | --- | --- | --- |
| type | The connector type | meta_dataset_quality |  | Yes |
| access_token | The Meta access token |  |  | Yes |
| app_secret | The Meta OAuth app secret. |  |  | No |
| dataset_id | The ID of dataset (Pixel) to retrieve quality data. |  |  | Yes |
| agent_name | The normalized value of the partner_agent field is used to filter only events sent with partner_agent |  |  | No |
| event_type | The type of event. Currently supported only website event. |  | WEBSITE | Yes |
| web_metric_type | The metric of event for website and supported following values. | Supported values:   - EVENT_MATCH_QUALITY - ADDITIONAL_CONVERSIONS_REPORTED_FOR_PARAMETERS - EVENT_MATCH_QUALITY_DIAGNOSTICS - EVENT_COVERAGE - ADDITIONAL_CONVERSIONS_REPORTED_FOR_EVENT_COVERAGE - EVENT_DEDUPLICATION - DATA_FRESHNESS - ADDITIONAL_CONVERSIONS_REPORTED_FOR_EVENT - ADDITIONAL_CONVERSIONS_REPORTED | EVENT_MATCH_QUALITY | Yes |
| retry_limit | The maximum retry limit. |  | 7 | No |
| initial_retry_wait | The time await for the first retry in seconds. |  | 2 seconds | No |
| max_retry_wait | The maximum time for the retry in seconds. |  | 240 seconds | No |
| connection_timeout | The timeout connection setting in seconds. |  | 300 seconds | No |
| read_timeout | The read timeout setting in seconds. |  | 120 seconds | No |


### Sample Workflow Code

Visit [Treasure Boxes](https://github.com/treasure-data/treasure-boxes/tree/master/td_load/s3) for a sample workflow code.

# Import from Meta Dataset via CLI (Toolbelt)

Before setting up the connector, install the most current [TD Toolbelt](https://toolbelt.treasuredata.com/).

## Create Configuration File (load.yml)


```
in:
```

type: meta_dataset_quality

access_token: token

app_secret: 9111...

dataset_id: 1234567901

agent_name:

event_type: WEBSITE

web_metric_type: EVENT_MATCH_QUALITY

retry_limit: 7

initial_retry_wait: 2

max_retry_wait: 240

connection_timeout: 300

read_timeout: 120


```
out:
  mode: append
```

### Parameters Reference

| Name | Description | Value | Default Value | Required |
|  --- | --- | --- | --- | --- |
| type | The connector type | meta_dataset_quality |  | Yes |
| access_token | The Meta access token |  |  | Yes |
| app_secret | The Meta OAuth app secret. |  |  | No |
| dataset_id | The ID of dataset (Pixel) to retrieve quality data. |  |  | Yes |
| agent_name | The normalized value of the partner_agent field is used to filter only events sent with partner_agent |  |  | No |
| event_type | The type of event. Currently supported only website event. |  | WEBSITE | Yes |
| web_metric_type | The metric of event for website and supported following values. | Supported values:   - EVENT_MATCH_QUALITY - ADDITIONAL_CONVERSIONS_REPORTED_FOR_PARAMETERS - EVENT_MATCH_QUALITY_DIAGNOSTICS - EVENT_COVERAGE - ADDITIONAL_CONVERSIONS_REPORTED_FOR_EVENT_COVERAGE - EVENT_DEDUPLICATION - DATA_FRESHNESS - ADDITIONAL_CONVERSIONS_REPORTED_FOR_EVENT - ADDITIONAL_CONVERSIONS_REPORTED | EVENT_MATCH_QUALITY | Yes |
| retry_limit | The maximum retry limit. |  | 7 | No |
| initial_retry_wait | The time await for the first retry in seconds. |  | 2 seconds | No |
| max_retry_wait | The maximum time for the retry in seconds. |  | 240 seconds | No |
| connection_timeout | The timeout connection setting in seconds. |  | 300 seconds | No |
| read_timeout | The read timeout setting in seconds. |  | 120 seconds | No |


## Data Preview

To preview the data, use the *td connector:preview* command.


```
$ td connector:preview load.yml​
```

The guess command requires more than 3 rows and 2 columns in the source data file because the command assesses the column definition using sample rows from the source data.

If the system detects your column name or column type unexpectedly, modify the load.yml file and preview again.

## Execute Load Job

Submit the load job.
It might take a couple of hours, depending on the size of the data. Be sure to specify the Treasure Data database and table where the data should be stored.

Treasure Data also recommends specifying *--time-column* option because Treasure Data’s storage is partitioned by time (see [data partitioning](http://docs.treasuredata.com/display/PD/Data+Partitioning+in+Treasure+Data)). If this option is not provided, the data connector chooses the first *long* or *timestamp* column as the partitioning time. The type of the column specified by *--time-column* must be either of *long* and *timestamp* type.

If your data doesn’t have a time column, you can add a time column by using *add_time* filter option. For more details see [add_time filter plugin](http://docs.treasuredata.com/display/PD/add_time+Filter+Function).


```
$ td connector:issue load.yml --database td_sample_db --table td_sample_table \
  --time-column created_at
```

The connector:issue command assumes that you have already created a *database(td_sample_db)*and a *table(td_sample_table)*. If the database or the table does not exist in TD, this command fails. Create the database and table manually or use *--auto-create-table* option with *td connector:issue* command to auto-create the database and table.


```
$ td connector:issue load.yml --database td_sample_db --table td_sample_table
 --time-column created_at --auto-create-table
```

The data connector does not sort records on the server side. To use time-based partitioning effectively, sort records in files beforehand.

If you have a field called *time*, you don’t have to specify the *--time-column* option.


```
$ td connector:issue load.yml --database td_sample_db --table td_sample_table
```

### Import Modes

You can specify file import mode in the out section of the load.yml file. The out: section controls how data is imported into a Treasure Data table. For example, you may choose to append data or replace data in an existing table in Treasure Data.

| Mode | **Description** | **Examples** |
|  --- | --- | --- |
| Append | Records are appended to the target table. | in:    ...  out:    mode: append |
| Always Replace | Replaces data in the target table.  Any manual schema changes made to the target table remain intact. | in:    ...  out:    mode: replace |
| Replace on new data | Replaces data in the target table only when there is new data to import. | in:    ...  out:    mode: replace_on_new_data |


## Scheduling Executions

You can schedule periodic data connector execution for incremental file import. Treasure Data configures our scheduler carefully to ensure high availability.

For the scheduled import, you can import all files that match the specified prefix and one of these fields by condition:

- If use_modified_time is disabled, the last path is saved for the next execution. On the second and subsequent runs, the connector only imports files that come after the last path in alphabetical order.
- Otherwise, the time that the job is executed is saved for the next execution. On the second and subsequent runs, the connector only imports files that were modified after that execution time in alphabetical order.


### Create a Schedule Using the TD Toolbelt

A new schedule can be created using the *td connector:create* command.


```
$ td connector:create daily_import "10 0 * * *" \
    td_sample_db td_sample_table load.yml
```

Treasure Data also recommends that you specify the *--time-column* option, because Treasure Data’s storage is partitioned by time (see also [data partitioning](http://docs.treasuredata.com/display/PD/Data+Partitioning+in+Treasure+Data)).


```
$ td connector:create daily_import "10 0 * * *" \
    td_sample_db td_sample_table load.yml \
    --time-column created_at
```

The `cron` parameter also accepts three special options: `@hourly`, `@daily`, and `@monthly`.

By default, the schedule is set up in the UTC timezone. You can set the schedule in a timezone using -t or --timezone option. `--timezone` option supports only extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles', etc. Timezone abbreviations like PST, CST are *not* supported and might lead to unexpected schedules.

### List All Schedules

You can see the list of currently scheduled entries by running the command *td connector:list*.


```
$ td connector:list
+--------------+--------------+----------+-------+--------------+-----------------+---------------------------------------------+
| Name         | Cron         | Timezone | Delay | Database     | Table           | Config                                      |
+--------------+--------------+----------+-------+--------------+-----------------+---------------------------------------------+
| daily_import | 10 0 * * *   | UTC      | 0     | td_sample_db | td_sample_table | {"in"=>{"type"=>"meta_dataset_quality",...} |
+--------------+--------------+----------+-------+--------------+-----------------+---------------------------------------------+
```

### Show Schedule Settings and History

*td connector:show* shows the execution setting of a schedule entry.


```
% td connector:show daily_import
```

Name : daily_import

Cron : 10 0 * * *

Timezone : UTC

Delay : 0

Database : joe_db

Table : meta_dataset_quality_shed

Config

in:

access_token: "***"

app_secret: "***"

dataset_id: '1234567890'

event_type: WEBSITE

web_metric_type: EVENT_MATCH_QUALITY

retry_limit: 3

initial_retry_wait: 1

max_retry_wait: 240

connection_timeout: 300

read_timeout: 120

type: meta_dataset_quality

*td connector:history* shows the execution history of a scheduled entry. To investigate the results of each individual run, use *td job jobid*.


```
% td connector:history daily_import
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| JobID  | Status  | Records | Database     | Table           | Priority | Started                   | Duration |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| 578066 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-18 00:10:05 +0000 | 160      |
| 577968 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-17 00:10:07 +0000 | 161      |
| 577914 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-16 00:10:03 +0000 | 152      |
| 577872 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-15 00:10:04 +0000 | 163      |
| 577810 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-14 00:10:04 +0000 | 164      |
| 577766 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-13 00:10:04 +0000 | 155      |
| 577710 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-12 00:10:05 +0000 | 156      |
| 577610 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-11 00:10:04 +0000 | 157      |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
8 rows in set
```

### Delete Schedule

*td connector:delete* removes the schedule.


```
$ td connector:delete daily_import
```