Polytomic Metadata

Polytomic Metadata is a group of collections comprising your Polytomic sync and model configurations as well as the run history for all syncs. You can create this connection to sync from using a Polytomic API key:

1. Obtain your Polytomic API key. There are two categories depending on whether you have multiple organizations/workspaces in Polytomic or just one (please email us at [email protected] if you have questions about this):

   1. If you only have one Polytomic workspace, retrieve your API key by visiting your Polytomic Settings console.
   2. If you have multiple workspaces/organizations or are a Polytomic Connect customer, use your Partner Key to make data from all organizations visible. If you are running Polytomic on-premises and fit this category, use your Deployment Key in place of a Partner Key.

2. In Polytomic, go to Connections → Add Connection → Polytomic Metadata.

3. If you are in Category (i) above, set your Authentication Method to Personal API Key. Otherwise set it to Partner API Key.

4. Enter your Polytomic API key from Step 1:

5. Click Save.

Syncing from Polytomic Metadata

Use Bulk Syncs to sync Polytomic Metadata to your data warehouses, databases, and cloud storage buckets like S3.

Use Model Syncs to sync Polytomic Metadata to your spreadsheets and SaaS applications.

Available collections

The following collections are available to sync from Polytomic Metadata. For those managing multiple organizations/workspaces (including with Polytomic Connect ), each collection also contains an Organization ID field so you can see which organization the corresponding entry came from.

• Bulk Syncs: a collection of settings for each Bulk Sync. Fields include the sync creater, source connection, destination connection, and so on.

• Bulk Sync Executions: a history collection of each Bulk Sync run and its statistics (start and completion time, record count, etc).

• Bulk Sync Schema Executions: same as above except that this is broken down per synced table. Each entry in this collection designates a sync run for a single table within the overall Bulk Sync. You can find the synced table name in the Schema field.

• Connections: a collection listing your configuration per Connection. This also includes the Connection health status.

• Models: a collection listing the configuration for each of your Polytomic Models (this will be empty if no Models are defined).

• Model Fields: a collection listing all model fields. This contains a Model ID that can be used to join to the Models collection.

• Model Syncs: analogous to the Bulk Syncs collection except for Model Syncs.

• Model Sync Executions: analogous to the Bulk Sync Executions collection except for Model Syncs.

• Organizations: for those with multiple organizations/workspaces, this collections lists all organizations so you can join against Organization ID on the other collections.