Metadata file

Exporting audiences metadata

An additional .METADATA suffixed JSON file can be optionally included with your Audience Export, which help to gain more context regarding the exported audience.

For instance, an export named: AudienceABC-Client123-7956915742.TSV will come with the following sibling file AudienceABC-Client123-7956915742.TSV.METADATA

Examples

Here are some examples of pretty-printed JSON metadata files content for both types of exports:

1) IDs only (CSV | TSV files)

{
  "node":  "receiver-node.cloud.optable.co",
  "filename":  "incoming-match-list-from-sender-node-1652383079.csv",
  "export":  {
    "created_at":  "2022-05-12T19:18:03.136814Z",
    "updated_at":  "2022-05-12T19:18:03.136814Z",
    "identifiers_filter": [
      "ID_KIND_EMAIL_HASH",
      "ID_KIND_APPLE_IDFA",
      "ID_KIND_GOOGLE_GAID",
      "ID_KIND_CUSTOM_ID_1",
      "ID_KIND_CUSTOM_ID_8"
    ],
    "id_format":  {
      "type_prefix":  true,
      "type_column":  true,
      "include_header":  false
    }
  },
  "audience":  {
    "id":  10,
    "name":  "Incoming Match - list from sender node",
    "labels": [
      {
        "id": 15,
        "name": "Retail"
      }
    ], 
    "created_at":  "2022-05-12T18:56:02.997876Z",
    "updated_at":  "2022-05-12T18:56:19.563226Z"
  },
  "partner":  {
    "name":  "Sender Node",
    "hostname":  "sender-node.cloud.optable.co",
    "node_id":  "sender1"
  },
  "match":  {
    "id":  4,
    "name":  "list from sender node",
    "created_at":  "2022-05-12T18:56:02.999111Z",
    "updated_at":  "2022-05-12T18:56:15.935110Z"
  }
}

2) Clusters (JSON files)

{
  "node":  "receiver-node.cloud.optable.co",
  "filename":  "incoming-match-list-from-sender-node-1652383079.json",
  "export":  {
    "created_at":  "2022-05-12T19:18:03.136814Z",
    "updated_at":  "2022-05-12T19:18:03.136814Z",
    "identifiers_filter": [
      "ID_KIND_EMAIL_HASH",
      "ID_KIND_APPLE_IDFA",
      "ID_KIND_GOOGLE_GAID",
      "ID_KIND_CUSTOM_ID_1",
      "ID_KIND_CUSTOM_ID_8"
    ],
    "cluster_format":  {
      "include_traits":  false,
      "include_sources":  true
    }
  },
  "audience":  {
    "id":  10,
    "name":  "Incoming Match - list from sender node",
    "labels": [
      {
        "id": 15,
        "name": "Retail"
      }
    ],     
    "created_at":  "2022-05-12T18:56:02.997876Z",
    "updated_at":  "2022-05-12T18:56:19.563226Z"
  },
  "partner":  {
    "name":  "Sender Node",
    "hostname":  "sender-node.cloud.optable.co",
    "node_id":  "sender1"
  },
  "match":  {
    "id":  4,
    "name":  "list from sender node",
    "created_at":  "2022-05-12T18:56:02.999111Z",
    "updated_at":  "2022-05-12T18:56:15.935110Z"
  }
}

Please note the partner and match objects will only be present when exporting a Matched Audience

How to Use It?

In the UI, simply toggle the checkbox to have a metadata file included during the export. If you do not wish to export the metadata file, you can uncheck this box.

Checkbox to include/exclude Metadata JSON file in Audience Export

If using the CLI, use the flag --export-metadata while exporting your audience.

Last updated