Skip to main content
API docs by Redocly

Collaboration Management Playbook (CM 1.0)

Download OpenAPI specification:Download

The Collaborations Playbook introduces a new set of controls that act as a data clean room command center, allowing you to coordinate projects with ease and transparency. Collaborations replace legacy permissions and provide additional project management options and visibility across clean room operations. Please note, this playbook is for Collaboration management only. For details on managing Bunkers, Datasets, Destinations, and Queries, please refer to the respective playbooks.

InfoSum Support | Terms of Service | Official Documentation

About Collaborations: A Collaboration is a structured project space that brings together multiple companies, their shared assets (such as Bunkers and Destinations), and role-based access to execute a use case. Collaborations are designed to simplify project setup, provide transparency with event logs, and allow members to coordinate operations in a data clean room with confidence.

Collaboration Roles

  • Owner: Creates and closes collaborations, adds members and assigns roles. Any user with the correct user roles can assume this role.
  • Operator: Can run queries and activations. Must be assigned by owner at collaboration creation.
  • Contributor: Can add and modify assets within the collaboration. Must be assigned by owner at collaboration creation.
  • Viewer: Can view collaboration assets and activity logs. Must be assigned by owner at collaboration creation.

Owner Task List:

  1. Create Collaboration
  2. List Collaborations
  3. Get Collaboration
  4. Leave Collaboration
  5. Close Collaboration

Operator Task List:

  1. See the Insight Queries Playbook for additional details on creating insight queries.
  2. See the Activation & Destination Playbook for additional details on creating activation queries and exporting them to destinations.

Contributor Task List:

  1. Add Dataset
  2. Remove Dataset
  3. Add Destination
  4. Remove Destination

Detailed Log Viewer Tasks:

  1. Get Dataset Stats
  2. Get Key Stats
  3. Get Attribute Stats
  4. Get Export Column Stats
  5. List Collaborations Events
  6. Export Collaborations Event Log

Parameter Reference Table

Role Type Step Number Parameter Name Parameter Structure Where to find it When to collect
Owner 1 Company ID xxx Must be requested from any collaboration partners Have ready before hand or pull from previous steps.
Owner 3, 4, 5 Collaboration ID CLB.xxx Output of previous steps, or in URL of Collaboration page Have ready before hand or pull from previous steps.
Contributor 1, 2 Dataset ID AWS_REGION.xxx In URL of Bunkers page Have ready before hand.
Contributor 3, 4 Destination ID DST.xx in URL of Destinations page Have ready before hand
Detailed Log Viewer 1, 2, 3, 4 Dataset ID AWS_REGION.xxx In URL of Bunkers page Have ready before hand.
Detailed Log Viewer 1, 2, 3, 4, 5, 6 Collaboration ID CLB.xxx Output of previous steps, or in URL of Collaboration page Have ready before hand or pull from previous steps.

Owner

Creates and closes collaborations, adds members and assigns roles. Any user with the correct user roles can assume this role.

1. Create Collaboration

Creates a new collaboration with the provided company IDs as members. Members cannot be added after the collaboration is created.

Authorizations:
apikeyAuth
Request Body schema: application/json
required
required
Array of objects
object (Rights)
description
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "collaborators": [
    ],
  • "creator_rights": {
    },
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "collaboration_id": "string"
}

2. List Collaborations

Returns a list of collaboration summaries where the requesting users company is the owner or a member. The output is affected by provided filters.

Authorizations:
apikeyAuth
query Parameters
pagination.page
integer

The requested page of records. Default is 1.

pagination.per_page
integer

The number of records to return per page. Maximum is 500. Default is 100.

order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'created_time,name DESC' The values are seperated by space, '{column} {ASC/DESC}' Valid columns: created_date_time, updated_date_time, owner, status, name

filter
string

Supported filters are id, name, description, created_date_time, updated_date_time, owner, members, status

Responses

Response samples

Content type
application/json
{
  • "collaborations": [
    ],
  • "pagination": {
    }
}

3. Get Collaboration

Returns the details for the requested collaboration ID.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to get details about.

Responses

Response samples

Content type
application/json
{
  • "collaboration": {
    }
}

4. Close Collaboration

Closes a collaboration you own. Irreversible. This means that the collaboration can no longer be used for new queries or exports but previous activity can still be seen.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to close.

Responses

Response samples

Content type
application/json
{ }

5. Leave Collaboration

Leaving the collaboration will mean the leaving company will no longer be able to see any details about the collaboration including the event logs.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to leave.

Responses

Response samples

Content type
application/json
{ }

Operator

Operators can run queries and activations.

Contributor

Contributors can add and remove datasets and destinations within a collaboration.

1. Add Dataset

Adds a dataset to the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration the dataset should be added to.

Request Body schema: application/json
required
activation_allowed
boolean
allowed_attributes
Array of strings
allowed_destination_types
Array of strings
attribute_restriction
boolean
collaboration_dataset_name
required
string
dataset_id
required
string
destination_type_restriction
boolean
exportable_to_members
Array of strings
intersection_only
boolean

Responses

Request samples

Content type
application/json
{
  • "activation_allowed": true,
  • "allowed_attributes": [
    ],
  • "allowed_destination_types": [
    ],
  • "attribute_restriction": true,
  • "collaboration_dataset_name": "string",
  • "dataset_id": "string",
  • "destination_type_restriction": true,
  • "exportable_to_members": [
    ],
  • "intersection_only": true
}

Response samples

Content type
application/json
{ }

2. Remove Dataset

Removes a dataset owned by the caller from the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration the dataset should be removed from.

dataset_id
required
string

The ID of the dataset to be removed from the collaboration.

Responses

Response samples

Content type
application/json
{ }

3. Add Destination

Adds a destination to the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration the destination should be added to.

Request Body schema: application/json
required
destination_id
required
string

Responses

Request samples

Content type
application/json
{
  • "destination_id": "string"
}

Response samples

Content type
application/json
{ }

4. Remove Destination

Removes a destination owned by the caller from the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration the destination should be removed from.

destination_id
required
string

The ID of the destination to remove.

Responses

Response samples

Content type
application/json
{ }

Detail Log Viewer

Detail Log Viewers can view the collaboration's logs and audit trails.

1. Get Dataset Stats

Get the counts for dataset properties like number of keys, categories or rows in the context of the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to get dataset stats from.

dataset_id
required
string

The id of the dataset to get summary stats for.

Responses

Response samples

Content type
application/json
{
  • "attribute_columns": "string",
  • "export_columns": "string",
  • "key_columns": "string",
  • "total_rows": "string"
}

2. Get Key Stats

Get detailed statistics for the keys in the given dataset in the context of the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to get dataset stats from.

dataset_id
required
string

The id of the dataset to get summary stats for.

Responses

Response samples

Content type
application/json
{
  • "key_id_to_stats": {
    }
}

3. Get Attribute Stats

Get detailed statistics for the attributes in the given dataset in the context of the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to get dataset stats from.

dataset_id
required
string

The id of the dataset to get summary stats for.

Responses

Response samples

Content type
application/json
{
  • "id_to_representations_stats": {
    }
}

4. Get Export Column Stats

Get detailed statistics for the export columns in the given dataset in the context of the collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to get dataset stats from.

dataset_id
required
string

The id of the dataset to get export column stats for.

Responses

Response samples

Content type
application/json
{
  • "label_to_stats": {
    }
}

5. List Collaboration Events

Lists the events associated with this collaboration.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to fetch events for.

query Parameters
pagination.page
integer

The requested page of records. Default is 1.

pagination.per_page
integer

The number of records to return per page. Maximum is 500. Default is 100.

order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'created_time,name DESC' The values are seperated by space, '{column} {ASC/DESC}' Valid columns: event_date_time

filter
string

Supported filters are event_type and company_id

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

6. Export Collaboration Events

Exports the events associated with this collaboration as a csv file.

Authorizations:
apikeyAuth
path Parameters
collaboration_id
required
string

The ID of the collaboration to export events for.

query Parameters
order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'created_time,name DESC' The values are seperated by space, '{column} {ASC/DESC}' Valid columns: event_date_time

filter
string

Supported filters are event_type and company_id

Responses

Response samples

Content type
application/json
"string"