# Models

## The v1\_UserGroupResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_UserGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the group."},"created_at":{"type":"string","description":"The creation timestamp of the group."},"updated_at":{"type":"string","description":"The last update timestamp of the group."},"users":{"type":"array","items":{"type":"string"},"description":"List of user IDs of the members in the group."},"name":{"type":"string","description":"The name of the group."},"icon":{"type":"string","description":"The icon associated with the group."},"description":{"type":"string","description":"The description of the group."},"workspace_id":{"type":"string","description":"The ID of the workspace associated with the grop."},"snowflake_role":{"description":"This field can be ignored."}}}}}}
```

## The v1\_MonitorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_MonitorResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the monitor."},"created_at":{"type":"string","description":"The timestamp when the monitor was created."},"updated_at":{"type":"string","description":"The timestamp when the data was last updated."},"integration":{"type":"string","description":"The identifier of the integration associated with the resource."},"target":{"type":"string","description":"The identifier of the resource that the monitor is watching."},"workspace":{"type":"string","description":"The identifier of the workspace."},"metric_type":{"type":"string","enum":["row_count","cardinality","mean","max","min","unique_percentage","null_percentage","freshness","custom_sql"],"description":"The type of metric."},"metric_config":{"type":"string","description":"Configuration for the metric."},"frequency":{"type":"integer","description":"The frequency with which this monitor is run."},"name":{"type":"string","description":"The full name of the monitor, includes the metric type and target resource."},"is_enabled":{"type":"boolean","description":"Whether the monitor is enabled."},"last_attempted_at":{"type":"string","description":"The timestamp of the last attempted monitor."},"last_success_at":{"type":"string","format":"date-time","description":"The timestamp of the last check on Secoda's access and ability to read the data source on which this monitor is set. This is connctivity check - not a data quality check."},"last_error_at":{"type":"string","description":"The timestamp of the last error, if any."},"last_error_message":{"type":"string","description":"The message associated with the last error, if any."},"condition_auto_sensitivity":{"type":"integer","description":"The automatic sensitivity condition."},"condition_manual_min":{"type":"integer","description":"The manual minimum condition if set by the user."},"condition_manual_max":{"type":"integer","description":"The manual maximum condition if set by the user."},"status":{"type":"string","enum":["normal","incident","error","learning","inactive"],"description":"The status of the monitor."},"display_metadata":{"type":"object","description":"This is an internally used object that provides additional information about the incident. This can be ignored by customers.","properties":{"target":{"type":"object","properties":{"icon":{"type":"string","description":"Icon associated with the target resource, if one exists."},"label":{"type":"string","description":"Title of the target resource."},"entity_type":{"type":"string","description":"The type of the target resource (e.g., column)."},"integration":{"type":"string","description":"The UUID of the integration from which the target resource is extracted."},"integration_type":{"type":"string","description":"The type of integration."}}}}},"last_measurement_value":{"type":"number","description":"The last measured value if one is available."},"last_incident":{"type":"string","description":"The UUID of the last active incident. If there are no active incidents (if the last incident has been closed), the field is set to null."},"last_measurement":{"type":"string","description":"The identifier of the last measurement."},"next_run_at":{"type":"string","description":"The timestamp for the next run. Note, the run may occur shortly after the time set, but never before."}}}}}}
```

## The v1\_IncidentResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_IncidentResponse":{"type":"object","properties":{"acknowledged_at":{"type":"string","format":"date-time","description":"The time that the incident was acknowledged at. This will be null if an incident hasn't been acknowledged yet."},"actions":{"type":"array","description":"A list of actions associated with the incident.","items":{"type":"object","properties":{"type":{"type":"string","enum":["notification_initial","notification_reminder","notification_resolved","acknowledged","resolved"]},"user_id":{"type":"string"},"user_name":{"type":"string"}}}},"created_at":{"type":"string","format":"date-time","description":"When the incident was created."},"display_metadata":{"type":"object","description":"This is an internally used object that provides additional information about the incident. This can be ignored by customers.","properties":{"monitor":{"type":"object","properties":{"label":{"type":"string"}}},"target":{"type":"object","properties":{"entity_type":{"type":"string","description":"The type of resource the incident is associated with."},"icon":{"type":"string"},"integration":{"type":"string","description":"The UUID of the integration associated with the resource."},"integration_type":{"type":"string","description":"The type of the integration that the resource is extracted from."},"label":{"type":"string"}}}}},"first_seen_at":{"type":"string","format":"date-time","description":"The first time this incident was observed."},"id":{"type":"string","description":"The UUID of the incident."},"last_notified_at":{"type":"string","format":"date-time","description":"The time of the last notification sent about this incident."},"last_seen_at":{"type":"string","format":"date-time","description":"The most recent occurence about this incident."},"monitor":{"type":"string","description":"The UUID of the associated monitor."},"name":{"type":"string","description":"The name of the incident, which indicates the type of metric set for the monitor."},"resolved_at":{"type":"string","format":"date-time","description":"The time that the incident was resolved. Will be null if the incident has not yet been resolved."},"status":{"type":"string","enum":["acknowledged","expired","resolved","active"],"description":"The status of the incident."},"summary":{"type":"string","description":"An automatically generated short summary of the incident."},"target":{"type":"string","description":"The UUID of the target resource being monitored for anomolies."},"updated_at":{"type":"string","format":"date-time","description":"The last updated time for the incident."},"value":{"type":"number","description":"The value of the measurement at the time of incident creation."}}}}}}
```

## The v1\_MeasurementResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_MeasurementResponse":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the measurement."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the measurement was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the when the measurement was updated."},"incident":{"type":"string","nullable":true,"description":"The UUID of the associated incident, if it exists. Otherwise, this is set to null."},"incident_metadata":{"type":"string","description":"Additional information about the incident."},"monitor":{"type":"string","description":"The UUID of the associated monitor."},"upper_threshold":{"type":"number","description":"The upper threshold of the measurement. A value crossing this threshold will trigger an incident. The threshold will be set to null when one is not configured, or the monitor is still learning the thresholds.\n"},"lower_threshold":{"type":"number","description":"The lower threshold of the measurement. A value crossing this threshold will trigger an incident. The threshold will be set to null when one is not configured, or the monitor is still learning the thresholds.\n"},"value":{"type":"number","description":"The exact value at the time of measurement."}}}}}}
```

## The v1\_MetricResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_MetricResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"metric_type":{"type":"string","description":"The type of graph created from the metric. Currently, only a line graph is supported."},"sql":{"type":"string","description":"The sql statement underlying the metric."},"dimension":{"type":"string","description":"The name of the column by which results should be grouped by. Can be None if no dimensions are desired."},"primary":{"type":"string","description":"The name of the column that should populate the Y axis. The data type of the column should be a number or integer."},"time":{"type":"string","description":"The name of the column that should populate the X axis. The data type of the column should be datetime."},"last_run":{"type":"string","format":"datetime","description":"The last time the metric was run."},"last_status":{"type":"string","description":"Whether the last run was successful. The status can also be pending if a run hasn't occured yet."},"last_error":{"type":"string","description":"If the last run failed, the error message will show up here."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_CollectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CollectionResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"pinned":{"type":"boolean","description":"Refers to whether the resource has been pinned by user."},"resource_count":{"type":"integer","description":"Indicates how many resources are part of the collection."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_QuestionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_QuestionResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"status":{"type":"string","description":"Indicates the status of the question. Values can be - <ul><li> Answered <li> Unanswered </ul>"},"priority":{"type":"string","description":"Indicates the priority of the question or request."},"reactions":{"type":"array","items":{"type":"string"},"description":"Represents the emoji reactions to a question."},"answer":{"type":"string","description":"Represents the verified answer of the question."},"assigned_to":{"type":"string","description":"Represents the user whom the question is assigned to."},"votes_sum":{"type":"integer","description":"Indicates the  amount of votes for the quesion."},"current_user_vote":{"type":"integer","description":"Represents the vote number of the current user."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_ReplyResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ReplyResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"reactions":{"type":"array","items":{"type":"string"},"description":"Represents the emoji reactions to a question."},"accepted_answer":{"type":"boolean","description":"Indicates if the answer is accepted or not. Values can be - <ul> <li> True <li> False</ul>"}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_DocumentResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_DocumentResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"parent_id":{"type":"string","description":"Indicates the UUID of the parent of the document, which is always another document."},"base_entity_id":{"type":"string","description":"Indicates the UUID of the highest level ancestor of the document."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_QueryResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_QueryResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"type":{"type":"string","description":"Indicates the type of query. Currently this is returned as None."},"freq":{"type":"integer","description":"Represents the frequency with which the query is running. Currently this will be returned as 0."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_LineageResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"from_entity":{"type":"string","description":"Indicates the source resource of the lineage."},"to_entity":{"type":"string","description":"Indicates the destination resource of the lineage."},"direction":{"type":"string","description":"Represents the flow of data between the source and destination. Values can be - <ul> <li> Upstream <li> Downstream</ul>","enum":["UPSTREAM","DOWNSTREAM"]},"is_manual":{"type":"boolean","description":"Represents if data lineage is manually created or not. Values can be - <ul><li> True <li> False </ul>"}}}}}}
```

## The v1\_LineageFromQueryTable object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageFromQueryTable":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"title":{"title":"Title","type":"string"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"database_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database Name"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"},"integration_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Title"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"}},"required":["id","created_at","updated_at","title"],"title":"LineageFromQueryTable","type":"object"}}}}
```

## The v1\_LineageFromQueryColumn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageFromQueryColumn":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"title":{"title":"Title","type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"database_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database Name"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"},"integration_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Title"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"}},"required":["id","created_at","updated_at","title"],"title":"LineageFromQueryColumn","type":"object"}}}}
```

## The v1\_LineageFromQueryColumnLineage object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageFromQueryColumnLineage":{"properties":{"from_column":{"$ref":"#/components/schemas/v1_LineageFromQueryColumn"},"to_column":{"$ref":"#/components/schemas/v1_LineageFromQueryColumn"}},"required":["from_column","to_column"],"title":"LineageFromQueryColumnLineage","type":"object"},"v1_LineageFromQueryColumn":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"title":{"title":"Title","type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"database_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database Name"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"},"integration_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Title"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"}},"required":["id","created_at","updated_at","title"],"title":"LineageFromQueryColumn","type":"object"}}}}
```

## The v1\_LineageFromQueryIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageFromQueryIn":{"properties":{"sql":{"title":"Sql","type":"string"},"dialect":{"title":"Dialect","type":"string"},"table_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table Id"},"default_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Database"},"default_schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Schema"}},"required":["sql","dialect"],"title":"LineageFromQueryIn","type":"object"}}}}
```

## The v1\_LineageFromQueryOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageFromQueryOut":{"properties":{"sql":{"title":"Sql","type":"string"},"source_tables":{"items":{"$ref":"#/components/schemas/v1_LineageFromQueryTable"},"title":"Source Tables","type":"array"},"column_lineages":{"items":{"$ref":"#/components/schemas/v1_LineageFromQueryColumnLineage"},"title":"Column Lineages","type":"array"},"target_table":{"anyOf":[{"$ref":"#/components/schemas/v1_LineageFromQueryTable"},{"type":"null"}]}},"required":["sql","source_tables","column_lineages"],"title":"LineageFromQueryOut","type":"object"},"v1_LineageFromQueryTable":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"title":{"title":"Title","type":"string"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"database_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database Name"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"},"integration_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Title"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"}},"required":["id","created_at","updated_at","title"],"title":"LineageFromQueryTable","type":"object"},"v1_LineageFromQueryColumnLineage":{"properties":{"from_column":{"$ref":"#/components/schemas/v1_LineageFromQueryColumn"},"to_column":{"$ref":"#/components/schemas/v1_LineageFromQueryColumn"}},"required":["from_column","to_column"],"title":"LineageFromQueryColumnLineage","type":"object"},"v1_LineageFromQueryColumn":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"title":{"title":"Title","type":"string"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"database_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database Name"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"},"integration_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Title"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"}},"required":["id","created_at","updated_at","title"],"title":"LineageFromQueryColumn","type":"object"}}}}
```

## The v1\_TagsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TagsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"name":{"type":"string","description":"Indicates the name of the tag."},"description":{"type":"string","description":"Indicates the description of the tag."},"color":{"type":"string","description":"Defines the different colors of the tags in HEX format."},"integration_id":{"type":"string","description":"The unique identifier of the integration the tag is pulled from. Null if the tag is created manually in Secoda."},"workspace_id":{"type":"string","description":"Indiactes the workspace ID where the tag belongs."}}}}}}
```

## The v1\_TeamsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TeamsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the team."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the team was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the team was last updated in Secoda UTC format."},"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."},"bi_dashboards":{"type":"boolean","description":"Whether to show the dashboards page to team members."}}},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"archived":{"type":"boolean","description":"Indicates if the team has been deleted."},"is_default_team":{"type":"boolean","description":"Indicates if the team is the default team. Any resource without a specified team will automatically get added to this team."},"onboarding_complete":{"type":"boolean","description":"This field will be deprecated."}}}}}}
```

## The v1\_UsersResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_UsersResponse":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the user."},"first_name":{"type":"string","description":"Indicates the first name of the user."},"last_name":{"type":"string","description":"Indicates the last name of the user."},"email":{"type":"string","description":"Indicates the email id of the user."},"role":{"type":"string","description":"Indicates the role of the user. Values can be - <ul><li> Admin <li> Editor <li> Viewer </ul>"},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"profile_picture":{"type":"string","description":"Indicates the file name of the profile picture for the user."},"pending":{"type":"boolean","description":"Represents if the user has been invited to the space but not accepted yet. Values can be - <ul> <li> \"True\" <li> \"False\" </ul>"},"user_groups":{"type":"array","description":"A list of UUIDs of groups the user belongs to.","items":{"type":"string"}},"bookmarks":{"type":"array","items":{"type":"string"},"description":"Represents the resorces that the user has bookmarked."},"workspace":{"type":"string","description":"Indicates the workspace of the user."},"is_service_account":{"type":"boolean","description":"Indicates if the user account is a service account or not. Values can be - <ul> <li >True <li> False </ul>"},"service_account_count_popularity":{"type":"boolean","description":"Indicates if the account counts towards popularity calculations. Values can be - <ul> <li> True <li> False </ul>"},"last_login":{"type":"string","format":"date-time","description":"Indicates the last time account was logged in to Secoda in UTC format."},"new_feature_acknowledged":{"type":"boolean","description":"Indicates if the new feature has been acknowleged or not. Values can be - <ul> <li >True <li> False </ul>"},"disabled":{"type":"boolean","description":"Represents if the account is disabled or not. Values can be - <ul> <li >True <li> False </ul>"}}}}}}
```

## The v1\_DashboardGroupResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_DashboardGroupResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"visible":{"type":"boolean","description":"This is a deprecated field."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_DashboardResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_DashboardResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"group":{"type":"string","description":"Indicates the name of the group."},"product":{"type":"string","description":"Indicates the name of the integration."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_ChartResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ChartResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"product":{"type":"string","description":"Indicates the name of the integration."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_ListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ListResponse":{"type":"object","properties":{"links":{"type":"object","description":"Indicates Links to associated pages.","properties":{"next":{"type":"string","description":"The link to the next page (null if there are no more pages)."},"previous":{"type":"string","description":"The link to the previous page (null if on the first page)."}}},"meta":{"type":"object","description":"Reprents the meta data of the response.","properties":{"page":{"type":"integer","description":"The current page number."},"previous_page":{"type":"integer","description":"The previous page number (null if on the first page)."},"next_page":{"type":"integer","description":"The next page number (null if on the last page)."}}},"count":{"type":"integer","description":"The total count of items returned."},"total_pages":{"type":"integer","description":"The total number of pages."}}}}}}
```

## The v1\_IntegrationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_IntegrationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created integration."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was last updated in Secoda UTC format."},"name":{"type":"string","description":"The name of the integration."},"type":{"type":"string","description":"The type of integration."},"credentials":{"type":"object","description":"The actual credentials of the integration will NOT be returned. Can you find the easter egg in this response parameter for native integrations?"},"workspace_id":{"type":"string","description":"The ID of the associated workspace."},"ssh_tunnel":{"type":"string","description":"Information about SSH tunnel if one is set update."},"execute_access":{"type":"array","items":{"type":"string"},"description":"List of IDs that have the permission to trigger the extracton."},"scheduled_extractions_hour":{"type":"integer","description":"Hour for scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_frequency":{"type":"integer","description":"Frequency in days of scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_next_run":{"type":"string","format":"date-time","description":"Next scheduled extraction run time. Will be null for custom extractions."},"scheduled_extractions_last_run":{"type":"string","description":"Last scheduled extraction run time (null in this response)."},"properties":{"type":"object","description":"Additional properties associated with the integration."},"preview_access_users":{"type":"array","items":{"type":"string"},"description":"List of users IDs with access to preview the data in the integration."},"preview_access_roles":{"type":"array","items":{"type":"string"},"description":"List of roles that are allowed to preview the data in the integration. <ul><li> Admin <li> Editor <li> Viewer </ul>"},"preview_access_groups":{"type":"array","items":{"type":"string"},"description":"List of users group IDs with access to preview the data in the integration."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the integration."}}}}}}
```

## The v1\_ColumnResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ColumnResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"data_type":{"type":"string","description":"Indicates the data type of the column."},"sort_order":{"type":"integer","description":"Indicates the order the column should be in amongst the other columns"},"is_pk":{"type":"boolean","description":"Whether the column is a primary key."},"hidden":{"type":"boolean","description":"This is a deprecated field."},"table_cluster":{"type":"string","description":"This is a deprecated field."},"table_database":{"type":"string","description":"Indicates the name of the database that the column belongs to."},"table_schema":{"type":"string","description":"Indicates the name of the schema that the column belongs to."},"table_title":{"type":"string","description":"Indicates the name of the table that the column belongs to."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_TableResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TableResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"database":{"type":"string","description":"Indicates the name of the database that the table belongs to."},"schema":{"type":"string","description":"Indicates the name of the schema that the table belongs to."},"cluster":{"type":"string","description":"This is a deprecated field."},"creation_query":{"type":"string","description":"If the table is a view, this indicates the query written to generate the view."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_CustomProperties object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomProperties":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom property."},"type":{"type":"string","enum":["string","number","multiselect","checkbox","user","resource","date"],"description":"The type of the custom property."},"order":{"type":"integer","description":"The order of the custom property."},"value":{"type":"string","description":"The value of the custom property."}}}}}}
```

## The v1\_BaseResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_BaseResourceRequest object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_BaseResourceRequest":{"type":"object","properties":{"title":{"type":"string","description":"The title of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource, if one exists."},"description":{"type":"string","description":"A description of the resource."},"entity_type":{"type":"string","description":"The type of the resource."},"definition":{"type":"string","description":"Mark down documentation to be added to the resource."},"parent":{"type":"string","description":"The ID of the parent resource. Please keep the resource heirarchy in mind when setting the parent."},"pii":{"type":"boolean","description":"Indicates whether the resource contains personally identifiable information (PII). Values can be - <ul><li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates whether the resource has been set as verified. Values can be - <ul><li> True <li> False</ul>"},"published":{"type":"boolean","description":"Indicates if the resource is visible to viewers or not. Values can be - <ul><li> True <li> False</ul>"},"teams":{"type":"array","items":{"type":"string"},"description":"A list of team IDs that the resource belongs to."},"owners":{"type":"array","items":{"type":"string"},"description":"A list of owner user IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"A list of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"A list of collection IDs the resource belongs to."},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tag IDs associated with the resources."},"subscribers":{"type":"array","description":"A list of user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.","items":{"type":"string"}}}}}}}
```

## The v1\_BasePatchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_BasePatchRequest":{"type":"object","properties":{"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","description":"Mark down documentation to be added to the resource."},"pii":{"type":"boolean","description":"Indicates whether the resource contains personally identifiable information (PII). Values can be - <ul><li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates whether the table has been set as verified. Values can be - <ul><li> True <li> False</ul>"},"published":{"type":"boolean","description":"Indicates if the resource is visible to viewers or not. Values can be - <ul><li> True <li> False</ul>"},"teams":{"type":"array","items":{"type":"string"},"description":"A list of team IDs that the resource belongs to."},"owners":{"type":"array","items":{"type":"string"},"description":"A list of owner user IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"A list of collection IDs the resource belongs to."},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tag IDs associated with the resources."},"subscribers":{"type":"array","description":"A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.","items":{"type":"string"}}}}}}}
```

## The v1\_EventPropertyResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_EventPropertyResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"type":{"type":"string","description":"The type of property associated with the event. Examples include string, enum, integer, etc."},"enum":{"type":"string","description":"If the property type is enum, this field indicates the various enum values."},"is_required":{"type":"boolean","description":"Set this to true if the property is required."}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_CatalogResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CatalogResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the resource."},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the resource in Secoda."},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the resource in Secoda."},"entity_type":{"type":"string","description":"The type of the resource."},"native_type":{"type":"string","description":"The type of the resource as indicated in the integration."},"icon":{"type":"string","description":"An optional icon for the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title of the resource in title case format."},"description":{"type":"string","description":"Description of the resource."},"definition":{"type":"string","description":"The markdown documentation of the resource."},"definition_version":{"type":"integer","description":"Version number of the resource documentation."},"multiplayers":{"type":"array","items":{"type":"object"},"description":"List of users interacting collaboratively on the resource [Not currently in use]."},"multiplayer_last_modified_by":{"type":"string","description":"The last user to modify the resource [Not currently in use]."},"multiplayer_last_modified":{"type":"string","description":"Timestamp of the last modification [Not currently in use]."},"owners":{"type":"array","items":{"type":"string"},"description":"List of User IDs associated with the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of Group IDs associated with the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of Collection IDs to which the resource belongs."},"tags":{"type":"array","items":{"type":"string"},"description":"List of Tag IDs associated with the resource."},"workspace_id":{"type":"string","description":"Workspace identifier in which the resource resides."},"published":{"type":"boolean","description":"Flag indicating whether the resource is published and visible to Viewers."},"archived":{"type":"boolean","description":"Flag indicating whether the resource is archived."},"archived_at":{"type":"string","nullable":true,"description":"Timestamp when the resource was archived."},"pii":{"type":"boolean","description":"Flag indicating if the resource contains personally identifiable information."},"verified":{"type":"boolean","description":"Flag indicating whether the resource has been verified."},"url":{"type":"string","description":"URL to access the resource on the web."},"parent":{"type":"string","description":"Parent ID of the resource."},"children_count":{"type":"integer","description":"Number of child entities associated with this resource."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of User IDs who have bookmarked the resource."},"integration":{"type":"string","description":"Identifier for integration from which the resource was extracted."},"external_updated_at":{"type":"string","description":"The last update timestamp of the resource in the source."},"internal_usage":{"type":"integer","description":"Number of times the resource has been viewed within Secoda."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the resource in Secoda."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the resource in the source."},"external_usage":{"type":"integer","description":"Number of times the resource has been viewed or queried in the Source."},"databuilder_id":{"type":"string","description":"Unique identifier for the resource."},"search_metadata":{"type":"object","description":"A set of properties used for indexing in search."},"sources":{"type":"array","items":{"type":"string"},"description":"Data sources that augment the resource, such as dbt."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of users subscribed to updates on the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"Teams IDs associated with the resource."},"stale":{"type":"boolean","description":"Flag indicating if the resource is considered stale."},"stale_at":{"type":"string","description":"Timestamp indicating when the resource was last marked as stale."},"forced_unstale_by_user":{"type":"boolean","description":"Flag indicating if the stale status of the resource was removed by a user action."},"current_user_permissions":{"type":"string","description":"Permissions of the current user on the resource."},"row_count":{"type":"integer","description":"The number of rows present in the resource."},"byte_size":{"type":"integer","description":"The size of the data used by the dashboard in bytes."},"display_metadata":{"type":"object","description":"Display-specific metadata for rendering the resource in Secoda."},"question_status":{"type":"string","description":"Status of the question [Not currently in use for Catalog resources]."},"question_priority":{"type":"string","nullable":true,"description":"Priority level of the question [Not currently in use for Catalog resources]."},"question_answered_by":{"type":"string","nullable":true,"description":"User ID of the person who answered the question [Not currently in use for Catalog resources]."},"question_assigned_to":{"type":"string","nullable":true,"description":"User ID of the person to whom the question is assigned [Not currently in use for Catalog resources]."}}}}}}
```

## The v1\_CatalogFilter object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CatalogFilter":{"type":"object","description":"A URL encoded, and serialized JSON object outlining the filter criteria for the request. The JSON object must meet the [JSON standards](https://www.json.org/json-en.html).","properties":{"operator":{"type":"string","description":"Logical operator to combine the operands (e.g., 'and', 'or').","enum":["and","or","not"]},"operands":{"type":"array","description":"An array of operand objects detailing individual filtering conditions.","items":{"type":"object","required":["operator","field","value"],"properties":{"operator":{"type":"string","description":"The operation to perform on the field.","enum":["contains","in","exact"]},"field":{"type":"string","description":"The name of the field on which to apply the operation."},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The value to compare against the field, can be a single value or an array of values depending on the operator."}}}}}}}}}
```

## The v1\_CatalogSort object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CatalogSort":{"type":"object","description":"A URL encoded, and serialized JSON object outlining the sort criteria for the request. The JSON object must meet the [JSON standards](https://www.json.org/json-en.html).","properties":{"field":{"type":"string","description":"The primary field on which to sort the results."},"order":{"type":"string","description":"The sorting order for the primary field.","enum":["asc","desc"]},"tie_breaker":{"type":"object","description":"An optional nested tie breaker for sorting if the primary sort results in ties.","$ref":"#/components/schemas/v1_CatalogTieBreaker"}}},"v1_CatalogTieBreaker":{"type":"object","properties":{"field":{"type":"string","description":"The field to use for the tie breaker sort."},"order":{"type":"string","description":"The order in which to sort the tie breaker field.","enum":["asc","desc"]},"tie_breaker":{"$ref":"#/components/schemas/v1_CatalogTieBreaker"}}}}}}
```

## The v1\_CatalogTieBreaker object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CatalogTieBreaker":{"type":"object","properties":{"field":{"type":"string","description":"The field to use for the tie breaker sort."},"order":{"type":"string","description":"The order in which to sort the tie breaker field.","enum":["asc","desc"]},"tie_breaker":{"$ref":"#/components/schemas/v1_CatalogTieBreaker"}}}}}}
```

## The v1\_CustomPropertyResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"entity_types":{"type":"array","items":{"type":"string"}}}}}}}
```

## The v1\_CustomPropertyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyRequest":{"type":"object","required":["name","value_type"],"properties":{"name":{"type":"string"},"entity_types":{"type":"array","items":{"type":"string","enum":["all","table","column","collection","glossary","document","question"]}},"value_type":{"type":"string","enum":["string","select","resource","user"]}}}}}}
```

## The v1\_CustomPropertyValueRequest object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyValueRequest":{"type":"object","required":["value"],"properties":{"value":{"type":"string"}}}}}}
```

## The v1\_DatabaseResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_DatabaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the database."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the database was created in Secoda."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the database was last updated in Secoda."},"entity_type":{"type":"string","description":"The type of the database."},"native_type":{"type":"string","description":"The native type of the database as it's referred to in the integration."},"icon":{"type":"string","description":"An optional icon for the database."},"title":{"type":"string","description":"The title of the database."},"title_full":{"type":"string","description":"The full title of the database, including its ancestry."},"title_cased":{"type":"string","description":"The title of the database in title case format."},"description":{"type":"string","description":"Description of the database."},"definition":{"type":"string","description":"The markdown documentation of the database."},"definition_version":{"type":"integer","description":"Version number of the database documentation."},"multiplayers":{"type":"array","items":{"type":"object"},"description":"List of users interacting collaboratively on the database [Not currently in use]."},"multiplayer_last_modified_by":{"type":"string","description":"The last user to modify the database [Not currently in use]."},"multiplayer_last_modified":{"type":"string","description":"Timestamp of the last modification [Not currently in use]."},"owners":{"type":"array","items":{"type":"string"},"description":"List of User IDs associated with the database."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of Group IDs associated with the database."},"collections":{"type":"array","items":{"type":"string"},"description":"List of Collection IDs to which the database belongs."},"tags":{"type":"array","items":{"type":"string"},"description":"List of Tag IDs associated with the database."},"workspace_id":{"type":"string","description":"Workspace identifier in which the database resides."},"published":{"type":"boolean","description":"Flag indicating whether the database is published and visible to Viewers."},"archived":{"type":"boolean","description":"Flag indicating whether the database is archived."},"archived_at":{"type":"string","nullable":true,"description":"Timestamp when the database was archived."},"pii":{"type":"boolean","description":"Flag indicating if the database contains personally identifiable information."},"verified":{"type":"boolean","description":"Flag indicating whether the database has been verified."},"url":{"type":"string","description":"URL to access the database on the web."},"parent":{"type":"string","description":"Parent ID of the database."},"children_count":{"type":"integer","description":"Number of child entities associated with this database."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of User IDs who have bookmarked the database."},"integration":{"type":"string","description":"Identifier for integration from which the database was extracted."},"external_updated_at":{"type":"string","description":"The last update timestamp of the database in the source."},"internal_usage":{"type":"integer","description":"Number of times the database has been viewed within Secoda."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the database in Secoda."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the database in the source."},"external_usage":{"type":"integer","description":"Number of times the database has been viewed or queried in the Source."},"databuilder_id":{"type":"string","description":"Unique identifier for the database."},"search_metadata":{"type":"object","description":"A set of properties used for indexing in search."},"sources":{"type":"array","items":{"type":"string"},"description":"Data sources that augment the database, such as dbt."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of users subscribed to updates on the database."},"teams":{"type":"array","items":{"type":"string"},"description":"Teams IDs associated with the database."},"stale":{"type":"boolean","description":"Flag indicating if the database is considered stale."},"stale_at":{"type":"string","description":"Timestamp indicating when the database was last marked as stale."},"forced_unstale_by_user":{"type":"boolean","description":"Flag indicating if the stale status of the database was removed by a user action."},"current_user_permissions":{"type":"string","description":"Permissions of the current user on the database."},"row_count":{"type":"integer","description":"The number of rows present in the database."},"byte_size":{"type":"integer","description":"The size of the data used by the dashboard in bytes."},"display_metadata":{"type":"object","description":"Display-specific metadata for rendering the database in Secoda."},"question_status":{"type":"string","description":"Status of the question [Not currently in use for Catalog resources]."},"question_priority":{"type":"string","nullable":true,"description":"Priority level of the question [Not currently in use for Catalog resources]."},"question_answered_by":{"type":"string","nullable":true,"description":"User ID of the person who answered the question [Not currently in use for Catalog resources]."},"question_assigned_to":{"type":"string","nullable":true,"description":"User ID of the person to whom the question is assigned [Not currently in use for Catalog resources]."}}}}}}
```

## The v1\_SchemaResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_SchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the schema."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the schema was created in Secoda."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the schema was last updated in Secoda."},"entity_type":{"type":"string","description":"The type of the schema."},"native_type":{"type":"string","description":"The native type of the schema as it's referred to in the integration."},"icon":{"type":"string","description":"An optional icon for the schema."},"title":{"type":"string","description":"The title of the schema."},"title_full":{"type":"string","description":"The full title of the schema, including its ancestry."},"title_cased":{"type":"string","description":"The title of the schema in title case format."},"description":{"type":"string","description":"Description of the schema."},"definition":{"type":"string","description":"The markdown documentation of the schema."},"definition_version":{"type":"integer","description":"Version number of the schema documentation."},"multiplayers":{"type":"array","items":{"type":"object"},"description":"List of users interacting collaboratively on the schema [Not currently in use]."},"multiplayer_last_modified_by":{"type":"string","description":"The last user to modify the schema [Not currently in use]."},"multiplayer_last_modified":{"type":"string","description":"Timestamp of the last modification [Not currently in use]."},"owners":{"type":"array","items":{"type":"string"},"description":"List of User IDs associated with the schema."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of Group IDs associated with the schema."},"collections":{"type":"array","items":{"type":"string"},"description":"List of Collection IDs to which the schema belongs."},"tags":{"type":"array","items":{"type":"string"},"description":"List of Tag IDs associated with the schema."},"workspace_id":{"type":"string","description":"Workspace identifier in which the schema resides."},"published":{"type":"boolean","description":"Flag indicating whether the schema is published and visible to Viewers."},"archived":{"type":"boolean","description":"Flag indicating whether the schema is archived."},"archived_at":{"type":"string","nullable":true,"description":"Timestamp when the schema was archived."},"pii":{"type":"boolean","description":"Flag indicating if the schema contains personally identifiable information."},"verified":{"type":"boolean","description":"Flag indicating whether the schema has been verified."},"url":{"type":"string","description":"URL to access the schema on the web."},"parent":{"type":"string","description":"Parent ID of the schema."},"children_count":{"type":"integer","description":"Number of child entities associated with this schema."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of User IDs who have bookmarked the schema."},"integration":{"type":"string","description":"Identifier for integration from which the schema was extracted."},"external_updated_at":{"type":"string","description":"The last update timestamp of the schema in the source."},"internal_usage":{"type":"integer","description":"Number of times the schema has been viewed within Secoda."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the schema in Secoda."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of users who have interacted with the schema in the source."},"external_usage":{"type":"integer","description":"Number of times the schema has been viewed or queried in the Source."},"databuilder_id":{"type":"string","description":"Unique identifier for the schema."},"search_metadata":{"type":"object","description":"A set of properties used for indexing in search."},"sources":{"type":"array","items":{"type":"string"},"description":"Data sources that augment the schema, such as dbt."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of users subscribed to updates on the schema."},"teams":{"type":"array","items":{"type":"string"},"description":"Teams IDs associated with the schema."},"stale":{"type":"boolean","description":"Flag indicating if the schema is considered stale."},"stale_at":{"type":"string","description":"Timestamp indicating when the schema was last marked as stale."},"forced_unstale_by_user":{"type":"boolean","description":"Flag indicating if the stale status of the schema was removed by a user action."},"current_user_permissions":{"type":"string","description":"Permissions of the current user on the schema."},"row_count":{"type":"integer","description":"The number of rows present in the schema."},"byte_size":{"type":"integer","description":"The size of the data used by the dashboard in bytes."},"display_metadata":{"type":"object","description":"Display-specific metadata for rendering the schema in Secoda."},"question_status":{"type":"string","description":"Status of the question [Not currently in use for Catalog resources]."},"question_priority":{"type":"string","nullable":true,"description":"Priority level of the question [Not currently in use for Catalog resources]."},"question_answered_by":{"type":"string","nullable":true,"description":"User ID of the person who answered the question [Not currently in use for Catalog resources]."},"question_assigned_to":{"type":"string","nullable":true,"description":"User ID of the person to whom the question is assigned [Not currently in use for Catalog resources]."}}}}}}
```

## The v1\_GlossaryResponse object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_GlossaryResponse":{"allOf":[{"$ref":"#/components/schemas/v1_BaseResponse"},{"type":"object","properties":{"synonyms":{"type":"array","items":{"type":"string"},"description":"List of synonyms for the term"},"parent_id":{"type":"string","description":"ID of the parent glossary term (optional)"}}}]},"v1_BaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"entity_type":{"type":"string","description":"The type of resource in Secoda."},"native_type":{"type":"string","description":"The native type of the resource as it is referred to in the integration."},"bookmarked_by":{"type":"array","items":{"type":"string"},"description":"List of member IDs that have bookmarked the resource."},"icon":{"type":"string","description":"The icon associated with the resource."},"title":{"type":"string","description":"The title of the resource."},"title_full":{"type":"string","description":"The full title of the resource, including its ancestry."},"title_cased":{"type":"string","description":"The title in a cased format."},"description":{"type":"string","description":"A description of the resource."},"definition":{"type":"string","format":"markdown","description":"The documentation of the resource, written in Mark Down format."},"definition_version":{"type":"integer","description":"The version of the resource's documentation."},"multiplayers":{"type":"array","items":{"type":"string"},"description":"List of members who have opened or worked with the resource recently."},"multiplayer_last_modified_by":{"type":"string","description":"The last member who modified this resource."},"multiplayer_last_modified":{"type":"string","format":"date-time","description":"The timestamp when the multiplayer was last modified in UTC format."},"owners":{"type":"array","items":{"type":"string"},"description":"List of owner IDs for the resource."},"owners_groups":{"type":"array","items":{"type":"string"},"description":"List of owner group IDs for the resource."},"collections":{"type":"array","items":{"type":"string"},"description":"List of IDs representing the collection(s) that the resource has been added to."},"tags":{"type":"array","items":{"type":"string"},"description":"List of tag IDs added to the resource."},"workspace_id":{"type":"string","description":"The ID of the workspace."},"total_usage":{"type":"integer","description":"The total usage count for the resource."},"published":{"type":"boolean","description":"Indicates if the resource is published and can be seen by Viewers."},"archived":{"type":"boolean","description":"Indicates if the resource is deleted."},"pii":{"type":"boolean","description":"Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>"},"verified":{"type":"boolean","description":"Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>"},"url":{"type":"string","description":"The URL associated with the resource."},"parent":{"type":"string","description":"The parent resource's ID."},"children_count":{"type":"integer","description":"The count of children entities of the resource."},"integration":{"type":"string","description":"The integration ID associated with the resource."},"external_updated_at":{"type":"string","format":"date-time","description":"The timestamp of the last update for the resource in the source."},"internal_usage":{"type":"integer","description":"The internal usage count for the resource."},"internal_users":{"type":"array","items":{"type":"string"},"description":"List of internal user IDs for the resource."},"external_users":{"type":"array","items":{"type":"string"},"description":"List of external user IDs for the resource extracted from the integration."},"external_usage":{"type":"integer","description":"The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource."},"databuilder_id":{"type":"string","description":"The databuilder ID associated with the resource. This is a generated field."},"search_metadata":{"type":"object","description":"Metadata related to indexing the resource for optimizing search."},"sources":{"type":"array","items":{"type":"string"},"description":"List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT."},"subscribers":{"type":"array","items":{"type":"string"},"description":"List of User IDs who subscribe to the resource."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the resource."},"stale":{"type":"boolean","description":"Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction."},"current_user_permissions":{"type":"object","description":"Permissions of the current user for this resource.","properties":{"read":{"type":"boolean"},"write":{"type":"boolean"},"execute":{"type":"boolean"}}}}}}}}
```

## The v1\_ActivityLogOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogOut":{"properties":{"id":{"title":"Id","type":"string"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"activity_type":{"title":"Activity Type","type":"string"},"performer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Performer Id"},"performer_type":{"enum":["API","AUTOMATION","INTEGRATION","EXTRACTION","SYSTEM","USER","UNKNOWN","MONITOR"],"title":"Performer Type","type":"string"},"performer_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogPerformerMetadata"},{"type":"null"}]},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Resource Type"},"resource_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogResourceMetadata"},{"type":"null"}]},"related_resource_ids":{"items":{"type":"string"},"title":"Related Resource Ids","type":"array"},"related_resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Related Resource Type"},"event_blocks":{"items":{"$ref":"#/components/schemas/v1_ActivityLogEventBlock"},"title":"Event Blocks","type":"array"},"logged_at":{"format":"date-time","title":"Logged At","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"version_history_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version History Id"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"required":["id","activity_type","performer_type","related_resource_ids","event_blocks","logged_at","created_at","updated_at","is_legacy"],"title":"ActivityLogOut","type":"object"},"v1_ActivityLogPerformerMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Src"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture"},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account"}},"required":["id"],"title":"ActivityLogPerformerMetadata","type":"object"},"v1_ActivityLogResourceMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"}},"required":["id"],"title":"ActivityLogResourceMetadata","type":"object"},"v1_ActivityLogEventBlock":{"properties":{"type":{"title":"Type","type":"string"},"style":{"enum":["normal","bold"],"title":"Style","type":"string"},"value":{"title":"Value","type":"string"}},"required":["type","style","value"],"title":"ActivityLogEventBlock","type":"object"}}}}
```

## The v1\_OutputLinks object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_OutputLinks":{"properties":{"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"}},"title":"OutputLinks","type":"object"}}}}
```

## The v1\_OutputMeta object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_OutputMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"}},"required":["page"],"title":"OutputMeta","type":"object"}}}}
```

## The v1\_CustomPropertyOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyOut":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"entity_types":{"default":[],"items":{"type":"string"},"title":"Entity Types","type":"array"},"value_type":{"title":"Value Type","type":"string"},"integration":{"anyOf":[{"$ref":"#/components/schemas/v1_LiteIntegrationOut"},{"type":"null"}]}},"required":["id","name","value_type"],"title":"CustomPropertyOut","type":"object"},"v1_LiteIntegrationOut":{"properties":{"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"},"id":{"format":"uuid","title":"Id","type":"string"}},"required":["name","type"],"title":"LiteIntegrationOut","type":"object"}}}}
```

## The v1\_LiteIntegrationOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LiteIntegrationOut":{"properties":{"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"},"id":{"format":"uuid","title":"Id","type":"string"}},"required":["name","type"],"title":"LiteIntegrationOut","type":"object"}}}}
```

## The v1\_CustomPropertyIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyIn":{"properties":{"name":{"title":"Name","type":"string"},"entity_types":{"default":[],"items":{"type":"string"},"title":"Entity Types","type":"array"},"value_type":{"title":"Value Type","type":"string"}},"required":["name","value_type"],"title":"CustomPropertyIn","type":"object"}}}}
```

## The v1\_CustomPropertyBulkUpdateOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyBulkUpdateOut":{"properties":{"entities":{"items":{"$ref":"#/components/schemas/v1_EntityWithCustomPropertyOut"},"title":"Entities","type":"array"}},"required":["entities"],"title":"CustomPropertyBulkUpdateOut","type":"object"},"v1_EntityWithCustomPropertyOut":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"properties2":{"additionalProperties":{"type":"string"},"title":"Properties2","type":"object"}},"required":["id","properties2"],"title":"EntityWithCustomPropertyOut","type":"object"}}}}
```

## The v1\_EntityWithCustomPropertyOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_EntityWithCustomPropertyOut":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"properties2":{"additionalProperties":{"type":"string"},"title":"Properties2","type":"object"}},"required":["id","properties2"],"title":"EntityWithCustomPropertyOut","type":"object"}}}}
```

## The v1\_CustomPropertyBulkUpdateIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyBulkUpdateIn":{"properties":{"entity_ids":{"items":{"type":"string"},"title":"Entity Ids","type":"array"},"properties":{"type":"object","additionalProperties":{"type":"string"},"title":"Properties"}},"required":["entity_ids","properties"],"title":"CustomPropertyBulkUpdateIn","type":"object"}}}}
```

## The v1\_CustomPropertyValueIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_CustomPropertyValueIn":{"properties":{"value":{"title":"Value","type":"string"}},"required":["value"],"title":"CustomPropertyValueIn","type":"object"}}}}
```

## The v1\_ExistDict object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ExistDict":{"properties":{"catalog":{"$ref":"#/components/schemas/v1_ExistValue"},"collection":{"$ref":"#/components/schemas/v1_ExistValue"},"glossary":{"$ref":"#/components/schemas/v1_ExistValue"},"document":{"$ref":"#/components/schemas/v1_ExistValue"},"question":{"$ref":"#/components/schemas/v1_ExistValue"},"bi_dashboard":{"$ref":"#/components/schemas/v1_ExistValue"}},"required":["catalog","collection","glossary","document","question","bi_dashboard"],"title":"ExistDict","type":"object"},"v1_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v1\_ExistValue object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v1\_TeamOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TeamOut":{"properties":{"sidebar_settings":{"additionalProperties":{"type":"boolean"},"title":"Sidebar Settings","type":"object"},"workspace_id":{"format":"uuid","title":"Workspace Id","type":"string"},"empty_state":{"anyOf":[{"$ref":"#/components/schemas/v1_ExistDict"},{"type":"null"}]},"id":{"format":"uuid","title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"name":{"title":"Name","type":"string"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"maxLength":6,"title":"Type","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"archived":{"default":false,"title":"Archived","type":"boolean"},"is_default_team":{"default":false,"title":"Is Default Team","type":"boolean"},"onboarding_completed":{"default":false,"title":"Onboarding Completed","type":"boolean"}},"required":["sidebar_settings","workspace_id","created_at","updated_at","name","type"],"title":"TeamOut","type":"object"},"v1_ExistDict":{"properties":{"catalog":{"$ref":"#/components/schemas/v1_ExistValue"},"collection":{"$ref":"#/components/schemas/v1_ExistValue"},"glossary":{"$ref":"#/components/schemas/v1_ExistValue"},"document":{"$ref":"#/components/schemas/v1_ExistValue"},"question":{"$ref":"#/components/schemas/v1_ExistValue"},"bi_dashboard":{"$ref":"#/components/schemas/v1_ExistValue"}},"required":["catalog","collection","glossary","document","question","bi_dashboard"],"title":"ExistDict","type":"object"},"v1_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v1\_LineageIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageIn":{"properties":{"from_entity":{"title":"From Entity","type":"string"},"to_entity":{"title":"To Entity","type":"string"},"direction":{"allOf":[{"$ref":"#/components/schemas/v1_LineageDirection"}],"default":"DOWNSTREAM"}},"required":["from_entity","to_entity"],"title":"LineageIn","type":"object"},"v1_LineageDirection":{"enum":["UPSTREAM","DOWNSTREAM"],"title":"LineageDirection","type":"string"}}}}
```

## The v1\_PagedTeamOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_PagedTeamOut":{"properties":{"results":{"items":{"$ref":"#/components/schemas/v1_TeamOut"},"title":"Results","type":"array"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"},"meta":{"$ref":"#/components/schemas/v1_OutputMeta"},"links":{"$ref":"#/components/schemas/v1_OutputLinks"}},"required":["results","count","total_pages","meta","links"],"title":"PagedTeamOut","type":"object"},"v1_TeamOut":{"properties":{"sidebar_settings":{"additionalProperties":{"type":"boolean"},"title":"Sidebar Settings","type":"object"},"workspace_id":{"format":"uuid","title":"Workspace Id","type":"string"},"empty_state":{"anyOf":[{"$ref":"#/components/schemas/v1_ExistDict"},{"type":"null"}]},"id":{"format":"uuid","title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"name":{"title":"Name","type":"string"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"maxLength":6,"title":"Type","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"archived":{"default":false,"title":"Archived","type":"boolean"},"is_default_team":{"default":false,"title":"Is Default Team","type":"boolean"},"onboarding_completed":{"default":false,"title":"Onboarding Completed","type":"boolean"}},"required":["sidebar_settings","workspace_id","created_at","updated_at","name","type"],"title":"TeamOut","type":"object"},"v1_ExistDict":{"properties":{"catalog":{"$ref":"#/components/schemas/v1_ExistValue"},"collection":{"$ref":"#/components/schemas/v1_ExistValue"},"glossary":{"$ref":"#/components/schemas/v1_ExistValue"},"document":{"$ref":"#/components/schemas/v1_ExistValue"},"question":{"$ref":"#/components/schemas/v1_ExistValue"},"bi_dashboard":{"$ref":"#/components/schemas/v1_ExistValue"}},"required":["catalog","collection","glossary","document","question","bi_dashboard"],"title":"ExistDict","type":"object"},"v1_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"},"v1_OutputMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"}},"required":["page"],"title":"OutputMeta","type":"object"},"v1_OutputLinks":{"properties":{"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"}},"title":"OutputLinks","type":"object"}}}}
```

## The v1\_TeamIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TeamIn":{"properties":{"name":{"title":"Name","type":"string"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"$ref":"#/components/schemas/v1_TeamType"}},"required":["name","type"],"title":"TeamIn","type":"object"},"v1_TeamType":{"enum":["OPEN","CLOSED"],"title":"TeamType","type":"string"}}}}
```

## The v1\_TeamType object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_TeamType":{"enum":["OPEN","CLOSED"],"title":"TeamType","type":"string"}}}}
```

## The v1\_PartialTeamIn object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_PartialTeamIn":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"$ref":"#/components/schemas/v1_TeamType"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"sidebar_settings":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Sidebar Settings"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"onboarding_completed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Onboarding Completed"}},"title":"PartialTeamIn","type":"object"},"v1_TeamType":{"enum":["OPEN","CLOSED"],"title":"TeamType","type":"string"}}}}
```

## The v1\_DBTTestResultsOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_DBTTestResultsOut":{"properties":{"warning":{"items":{"type":"string"},"title":"Warning","type":"array"},"failing":{"items":{"type":"string"},"title":"Failing","type":"array"}},"required":["warning","failing"],"title":"DBTTestResultsOut","type":"object"}}}}
```

## The v1\_PaginationMeta object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_PaginationMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"}},"required":["page","count","total_pages"],"title":"PaginationMeta","type":"object"}}}}
```

## The v1\_LineageDirection object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageDirection":{"enum":["UPSTREAM","DOWNSTREAM"],"title":"LineageDirection","type":"string"}}}}
```

## The v1\_LineageOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_LineageOut":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"from_entity_id":{"format":"uuid","title":"From Entity","type":"string"},"to_entity_id":{"format":"uuid","title":"To Entity","type":"string"},"direction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Direction"},"workspace_id":{"format":"uuid","title":"Workspace","type":"string"},"is_manual":{"default":false,"title":"Is Manual","type":"boolean"}},"required":["created_at","updated_at","from_entity_id","to_entity_id","workspace_id"],"title":"LineageOut","type":"object"}}}}
```

## The v1\_PaginationLinks object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_PaginationLinks":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"}},"title":"PaginationLinks","type":"object"}}}}
```

## The v1\_PagedLineageOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_PagedLineageOut":{"properties":{"links":{"$ref":"#/components/schemas/v1_PaginationLinks"},"meta":{"$ref":"#/components/schemas/v1_PaginationMeta"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"},"results":{"items":{"$ref":"#/components/schemas/v1_LineageOut"},"title":"Results","type":"array"}},"required":["links","meta","count","total_pages","results"],"title":"PagedLineageOut","type":"object"},"v1_PaginationLinks":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"}},"title":"PaginationLinks","type":"object"},"v1_PaginationMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"}},"required":["page","count","total_pages"],"title":"PaginationMeta","type":"object"},"v1_LineageOut":{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"from_entity_id":{"format":"uuid","title":"From Entity","type":"string"},"to_entity_id":{"format":"uuid","title":"To Entity","type":"string"},"direction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Direction"},"workspace_id":{"format":"uuid","title":"Workspace","type":"string"},"is_manual":{"default":false,"title":"Is Manual","type":"boolean"}},"required":["created_at","updated_at","from_entity_id","to_entity_id","workspace_id"],"title":"LineageOut","type":"object"}}}}
```

## The v1\_AiChatPoint object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiChatPoint":{"description":"Point for AI chat metrics","properties":{"total_chats":{"title":"Total Chats","type":"integer"}},"required":["total_chats"],"title":"AiChatPoint","type":"object"}}}}
```

## The v1\_AiChatTimeSeries object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiChatTimeSeries":{"description":"Time series data for AI chats","properties":{"points":{"items":{"$ref":"#/components/schemas/v1_AiChatTimeSeriesPoint"},"title":"Points","type":"array"},"granularity":{"title":"Granularity","type":"string"},"available_channels":{"default":["total_chats"],"items":{"type":"string"},"title":"Available Channels","type":"array"}},"required":["points","granularity"],"title":"AiChatTimeSeries","type":"object"},"v1_AiChatTimeSeriesPoint":{"description":"A single point in the AI chat time series","properties":{"total_chats":{"title":"Total Chats","type":"integer"},"timestamp":{"format":"date-time","title":"Timestamp","type":"string"},"group_data":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/v1_AiChatPoint"},"type":"object"},{"type":"null"}],"title":"Group Data"}},"required":["total_chats","timestamp"],"title":"AiChatTimeSeriesPoint","type":"object"},"v1_AiChatPoint":{"description":"Point for AI chat metrics","properties":{"total_chats":{"title":"Total Chats","type":"integer"}},"required":["total_chats"],"title":"AiChatPoint","type":"object"}}}}
```

## The v1\_AiChatTimeSeriesPoint object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiChatTimeSeriesPoint":{"description":"A single point in the AI chat time series","properties":{"total_chats":{"title":"Total Chats","type":"integer"},"timestamp":{"format":"date-time","title":"Timestamp","type":"string"},"group_data":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/v1_AiChatPoint"},"type":"object"},{"type":"null"}],"title":"Group Data"}},"required":["total_chats","timestamp"],"title":"AiChatTimeSeriesPoint","type":"object"},"v1_AiChatPoint":{"description":"Point for AI chat metrics","properties":{"total_chats":{"title":"Total Chats","type":"integer"}},"required":["total_chats"],"title":"AiChatPoint","type":"object"}}}}
```

## The v1\_AiChatRatedMessageItem object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiChatRatedMessageItem":{"description":"Individual AI chat item for rated messages list view","properties":{"id":{"title":"Id","type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"prompt":{"title":"Prompt","type":"string"},"user_id":{"title":"User Id","type":"string"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name"},"user_profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Profile Picture"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"sentiment":{"title":"Sentiment","type":"string"},"status":{"title":"Status","type":"string"}},"required":["id","title","prompt","user_id","created_at","sentiment","status"],"title":"AiChatRatedMessageItem","type":"object"}}}}
```

## The v1\_AiChatRatedMessages object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiChatRatedMessages":{"description":"List of AI chats with user ratings (thumbs up/down) with pagination and filtering","properties":{"items":{"items":{"$ref":"#/components/schemas/v1_AiChatRatedMessageItem"},"title":"Items","type":"array"},"total_count":{"title":"Total Count","type":"integer"},"has_next_page":{"title":"Has Next Page","type":"boolean"}},"required":["items","total_count","has_next_page"],"title":"AiChatRatedMessages","type":"object"},"v1_AiChatRatedMessageItem":{"description":"Individual AI chat item for rated messages list view","properties":{"id":{"title":"Id","type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"prompt":{"title":"Prompt","type":"string"},"user_id":{"title":"User Id","type":"string"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name"},"user_profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Profile Picture"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"sentiment":{"title":"Sentiment","type":"string"},"status":{"title":"Status","type":"string"}},"required":["id","title","prompt","user_id","created_at","sentiment","status"],"title":"AiChatRatedMessageItem","type":"object"}}}}
```

## The v1\_AiPromptsByMemberItem object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiPromptsByMemberItem":{"description":"Individual member item for prompts by member list view","properties":{"user_id":{"title":"User Id","type":"string"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name"},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email"},"user_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Role"},"user_profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Profile Picture"},"prompt_count":{"title":"Prompt Count","type":"integer"}},"required":["user_id","prompt_count"],"title":"AiPromptsByMemberItem","type":"object"}}}}
```

## The v1\_AiPromptsByMemberList object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_AiPromptsByMemberList":{"description":"List of members with their AI prompt counts with pagination and filtering","properties":{"items":{"items":{"$ref":"#/components/schemas/v1_AiPromptsByMemberItem"},"title":"Items","type":"array"},"total_count":{"title":"Total Count","type":"integer"},"has_next_page":{"title":"Has Next Page","type":"boolean"}},"required":["items","total_count","has_next_page"],"title":"AiPromptsByMemberList","type":"object"},"v1_AiPromptsByMemberItem":{"description":"Individual member item for prompts by member list view","properties":{"user_id":{"title":"User Id","type":"string"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name"},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email"},"user_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Role"},"user_profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Profile Picture"},"prompt_count":{"title":"Prompt Count","type":"integer"}},"required":["user_id","prompt_count"],"title":"AiPromptsByMemberItem","type":"object"}}}}
```

## The v1\_ActivityLogEventBlock object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogEventBlock":{"properties":{"type":{"title":"Type","type":"string"},"style":{"enum":["normal","bold"],"title":"Style","type":"string"},"value":{"title":"Value","type":"string"}},"required":["type","style","value"],"title":"ActivityLogEventBlock","type":"object"}}}}
```

## The v1\_ActivityLogPaginationMeta object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogPaginationMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"}},"required":["page","count","total_pages"],"title":"ActivityLogPaginationMeta","type":"object"}}}}
```

## The v1\_ActivityLogPerformerMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogPerformerMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Src"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture"},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account"}},"required":["id"],"title":"ActivityLogPerformerMetadata","type":"object"}}}}
```

## The v1\_ActivityLogResourceMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogResourceMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"}},"required":["id"],"title":"ActivityLogResourceMetadata","type":"object"}}}}
```

## The v1\_ResourceActivityLogOutPaginated object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ResourceActivityLogOutPaginated":{"properties":{"non_versioned_logs":{"items":{"$ref":"#/components/schemas/v1_ActivityLogOut"},"title":"Non Versioned Logs","type":"array"},"version_histories":{"items":{"$ref":"#/components/schemas/v1_VersionHistoryOut"},"title":"Version Histories","type":"array"},"total_pages":{"title":"Total Pages","type":"integer"},"count":{"title":"Count","type":"integer"},"meta":{"$ref":"#/components/schemas/v1_ActivityLogPaginationMeta"}},"required":["non_versioned_logs","version_histories","total_pages","count","meta"],"title":"ResourceActivityLogOutPaginated","type":"object"},"v1_ActivityLogOut":{"properties":{"id":{"title":"Id","type":"string"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"activity_type":{"title":"Activity Type","type":"string"},"performer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Performer Id"},"performer_type":{"enum":["API","AUTOMATION","INTEGRATION","EXTRACTION","SYSTEM","USER","UNKNOWN","MONITOR"],"title":"Performer Type","type":"string"},"performer_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogPerformerMetadata"},{"type":"null"}]},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Resource Type"},"resource_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogResourceMetadata"},{"type":"null"}]},"related_resource_ids":{"items":{"type":"string"},"title":"Related Resource Ids","type":"array"},"related_resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Related Resource Type"},"event_blocks":{"items":{"$ref":"#/components/schemas/v1_ActivityLogEventBlock"},"title":"Event Blocks","type":"array"},"logged_at":{"format":"date-time","title":"Logged At","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"version_history_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version History Id"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"required":["id","activity_type","performer_type","related_resource_ids","event_blocks","logged_at","created_at","updated_at","is_legacy"],"title":"ActivityLogOut","type":"object"},"v1_ActivityLogPerformerMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Src"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture"},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account"}},"required":["id"],"title":"ActivityLogPerformerMetadata","type":"object"},"v1_ActivityLogResourceMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"}},"required":["id"],"title":"ActivityLogResourceMetadata","type":"object"},"v1_ActivityLogEventBlock":{"properties":{"type":{"title":"Type","type":"string"},"style":{"enum":["normal","bold"],"title":"Style","type":"string"},"value":{"title":"Value","type":"string"}},"required":["type","style","value"],"title":"ActivityLogEventBlock","type":"object"},"v1_VersionHistoryOut":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"latest_activity_logged_at":{"format":"date-time","title":"Latest Activity Logged At","type":"string"},"resource_id":{"title":"Resource Id","type":"string"},"activity_logs":{"items":{"$ref":"#/components/schemas/v1_ActivityLogOut"},"title":"Activity Logs","type":"array"},"metadata":{"$ref":"#/components/schemas/v1_VersionHistoryMetadata"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"older_than_thirty_days":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Older Than Thirty Days"}},"required":["id","created_at","updated_at","latest_activity_logged_at","resource_id","activity_logs","metadata","is_legacy"],"title":"VersionHistoryOut","type":"object"},"v1_VersionHistoryMetadata":{"properties":{"prev":{"additionalProperties":true,"title":"Prev","type":"object"},"current":{"additionalProperties":true,"title":"Current","type":"object"},"definition_diff":{"additionalProperties":true,"title":"Definition Diff","type":"object"},"description_diff":{"additionalProperties":true,"title":"Description Diff","type":"object"},"secoda_entity_property_snapshot":{"anyOf":[{"$ref":"#/components/schemas/v1_SecodaEntityPropertySnapshot"},{"type":"null"}]}},"required":["prev","current","definition_diff","description_diff"],"title":"VersionHistoryMetadata","type":"object"},"v1_SecodaEntityPropertySnapshot":{"properties":{"owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners"},"owners_groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners Groups"},"collections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collections"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Published"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Verified"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"pii":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pii"},"teams":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Teams"},"properties2":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties2"}},"title":"SecodaEntityPropertySnapshot","type":"object"},"v1_ActivityLogPaginationMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"}},"required":["page","count","total_pages"],"title":"ActivityLogPaginationMeta","type":"object"}}}}
```

## The v1\_SecodaEntityPropertySnapshot object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_SecodaEntityPropertySnapshot":{"properties":{"owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners"},"owners_groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners Groups"},"collections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collections"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Published"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Verified"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"pii":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pii"},"teams":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Teams"},"properties2":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties2"}},"title":"SecodaEntityPropertySnapshot","type":"object"}}}}
```

## The v1\_VersionHistoryMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_VersionHistoryMetadata":{"properties":{"prev":{"additionalProperties":true,"title":"Prev","type":"object"},"current":{"additionalProperties":true,"title":"Current","type":"object"},"definition_diff":{"additionalProperties":true,"title":"Definition Diff","type":"object"},"description_diff":{"additionalProperties":true,"title":"Description Diff","type":"object"},"secoda_entity_property_snapshot":{"anyOf":[{"$ref":"#/components/schemas/v1_SecodaEntityPropertySnapshot"},{"type":"null"}]}},"required":["prev","current","definition_diff","description_diff"],"title":"VersionHistoryMetadata","type":"object"},"v1_SecodaEntityPropertySnapshot":{"properties":{"owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners"},"owners_groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners Groups"},"collections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collections"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Published"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Verified"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"pii":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pii"},"teams":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Teams"},"properties2":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties2"}},"title":"SecodaEntityPropertySnapshot","type":"object"}}}}
```

## The v1\_VersionHistoryOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_VersionHistoryOut":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"latest_activity_logged_at":{"format":"date-time","title":"Latest Activity Logged At","type":"string"},"resource_id":{"title":"Resource Id","type":"string"},"activity_logs":{"items":{"$ref":"#/components/schemas/v1_ActivityLogOut"},"title":"Activity Logs","type":"array"},"metadata":{"$ref":"#/components/schemas/v1_VersionHistoryMetadata"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"older_than_thirty_days":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Older Than Thirty Days"}},"required":["id","created_at","updated_at","latest_activity_logged_at","resource_id","activity_logs","metadata","is_legacy"],"title":"VersionHistoryOut","type":"object"},"v1_ActivityLogOut":{"properties":{"id":{"title":"Id","type":"string"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"activity_type":{"title":"Activity Type","type":"string"},"performer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Performer Id"},"performer_type":{"enum":["API","AUTOMATION","INTEGRATION","EXTRACTION","SYSTEM","USER","UNKNOWN","MONITOR"],"title":"Performer Type","type":"string"},"performer_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogPerformerMetadata"},{"type":"null"}]},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Resource Type"},"resource_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogResourceMetadata"},{"type":"null"}]},"related_resource_ids":{"items":{"type":"string"},"title":"Related Resource Ids","type":"array"},"related_resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Related Resource Type"},"event_blocks":{"items":{"$ref":"#/components/schemas/v1_ActivityLogEventBlock"},"title":"Event Blocks","type":"array"},"logged_at":{"format":"date-time","title":"Logged At","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"version_history_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version History Id"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"required":["id","activity_type","performer_type","related_resource_ids","event_blocks","logged_at","created_at","updated_at","is_legacy"],"title":"ActivityLogOut","type":"object"},"v1_ActivityLogPerformerMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Src"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture"},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account"}},"required":["id"],"title":"ActivityLogPerformerMetadata","type":"object"},"v1_ActivityLogResourceMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"}},"required":["id"],"title":"ActivityLogResourceMetadata","type":"object"},"v1_ActivityLogEventBlock":{"properties":{"type":{"title":"Type","type":"string"},"style":{"enum":["normal","bold"],"title":"Style","type":"string"},"value":{"title":"Value","type":"string"}},"required":["type","style","value"],"title":"ActivityLogEventBlock","type":"object"},"v1_VersionHistoryMetadata":{"properties":{"prev":{"additionalProperties":true,"title":"Prev","type":"object"},"current":{"additionalProperties":true,"title":"Current","type":"object"},"definition_diff":{"additionalProperties":true,"title":"Definition Diff","type":"object"},"description_diff":{"additionalProperties":true,"title":"Description Diff","type":"object"},"secoda_entity_property_snapshot":{"anyOf":[{"$ref":"#/components/schemas/v1_SecodaEntityPropertySnapshot"},{"type":"null"}]}},"required":["prev","current","definition_diff","description_diff"],"title":"VersionHistoryMetadata","type":"object"},"v1_SecodaEntityPropertySnapshot":{"properties":{"owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners"},"owners_groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Owners Groups"},"collections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collections"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"definition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Published"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Verified"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"pii":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pii"},"teams":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Teams"},"properties2":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties2"}},"title":"SecodaEntityPropertySnapshot","type":"object"}}}}
```

## The v1\_ActivityLogOutPaginated object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v1_ActivityLogOutPaginated":{"properties":{"results":{"items":{"$ref":"#/components/schemas/v1_ActivityLogOut"},"title":"Results","type":"array"},"total_pages":{"title":"Total Pages","type":"integer"},"count":{"title":"Count","type":"integer"},"meta":{"$ref":"#/components/schemas/v1_ActivityLogPaginationMeta"}},"required":["results","total_pages","count","meta"],"title":"ActivityLogOutPaginated","type":"object"},"v1_ActivityLogOut":{"properties":{"id":{"title":"Id","type":"string"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id"},"activity_type":{"title":"Activity Type","type":"string"},"performer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Performer Id"},"performer_type":{"enum":["API","AUTOMATION","INTEGRATION","EXTRACTION","SYSTEM","USER","UNKNOWN","MONITOR"],"title":"Performer Type","type":"string"},"performer_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogPerformerMetadata"},{"type":"null"}]},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Resource Type"},"resource_metadata":{"anyOf":[{"$ref":"#/components/schemas/v1_ActivityLogResourceMetadata"},{"type":"null"}]},"related_resource_ids":{"items":{"type":"string"},"title":"Related Resource Ids","type":"array"},"related_resource_type":{"anyOf":[{"enum":["API_KEY","AUTOMATION","AUTOMATION_JOB","BACKGROUND_JOB","COMMENT","CUSTOM_PROPERTY","DATABUILDER_JOB","DATA_ACCESS_REQUEST","IAM_ROLE","IAM_RESOURCE_POLICY","INCIDENT","INTEGRATION","INVITATION_LINK","LINEAGE","MARKETPLACE_INTEGRATION_SPEC","MARKETPLACE_INTEGRATION_SPEC_VERSION","METRIC","MONITOR","MONITOR_NOTIFICATION_RULE","OWNER","OWNER_GROUP","POLICY","POLICY_RESULT","QUERY","QUESTION","QUESTION_REPLY","REPORT","S3_OBJECT","SECODA_ENTITY","SUBSCRIBER","SUBSCRIBER_GROUP","TAG","TAG_GROUP","TEAM","USER","USER_GROUP","WIDGET","WORKSPACE"],"type":"string"},{"type":"null"}],"title":"Related Resource Type"},"event_blocks":{"items":{"$ref":"#/components/schemas/v1_ActivityLogEventBlock"},"title":"Event Blocks","type":"array"},"logged_at":{"format":"date-time","title":"Logged At","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"is_legacy":{"title":"Is Legacy","type":"boolean"},"version_history_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version History Id"},"secoda_entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secoda Entity Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"required":["id","activity_type","performer_type","related_resource_ids","event_blocks","logged_at","created_at","updated_at","is_legacy"],"title":"ActivityLogOut","type":"object"},"v1_ActivityLogPerformerMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Src"},"integration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Type"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"profile_picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture"},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account"}},"required":["id"],"title":"ActivityLogPerformerMetadata","type":"object"},"v1_ActivityLogResourceMetadata":{"properties":{"id":{"title":"Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"integration_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Id"}},"required":["id"],"title":"ActivityLogResourceMetadata","type":"object"},"v1_ActivityLogEventBlock":{"properties":{"type":{"title":"Type","type":"string"},"style":{"enum":["normal","bold"],"title":"Style","type":"string"},"value":{"title":"Value","type":"string"}},"required":["type","style","value"],"title":"ActivityLogEventBlock","type":"object"},"v1_ActivityLogPaginationMeta":{"properties":{"page":{"title":"Page","type":"integer"},"previous_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Previous Page"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"count":{"title":"Count","type":"integer"},"total_pages":{"title":"Total Pages","type":"integer"}},"required":["page","count","total_pages"],"title":"ActivityLogPaginationMeta","type":"object"}}}}
```

## The v2\_ExistDict object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v2_ExistDict":{"properties":{"catalog":{"$ref":"#/components/schemas/v2_ExistValue"},"collection":{"$ref":"#/components/schemas/v2_ExistValue"},"glossary":{"$ref":"#/components/schemas/v2_ExistValue"},"document":{"$ref":"#/components/schemas/v2_ExistValue"},"question":{"$ref":"#/components/schemas/v2_ExistValue"},"bi_dashboard":{"$ref":"#/components/schemas/v2_ExistValue"}},"required":["catalog","collection","glossary","document","question","bi_dashboard"],"title":"ExistDict","type":"object"},"v2_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v2\_ExistValue object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v2_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v2\_TeamOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v2_TeamOut":{"properties":{"sidebar_settings":{"additionalProperties":{"type":"boolean"},"title":"Sidebar Settings","type":"object"},"workspace_id":{"format":"uuid","title":"Workspace Id","type":"string"},"empty_state":{"anyOf":[{"$ref":"#/components/schemas/v2_ExistDict"},{"type":"null"}]},"id":{"format":"uuid","title":"Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"name":{"title":"Name","type":"string"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"maxLength":6,"title":"Type","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"archived":{"default":false,"title":"Archived","type":"boolean"},"is_default_team":{"default":false,"title":"Is Default Team","type":"boolean"},"onboarding_completed":{"default":false,"title":"Onboarding Completed","type":"boolean"}},"required":["sidebar_settings","workspace_id","created_at","updated_at","name","type"],"title":"TeamOut","type":"object"},"v2_ExistDict":{"properties":{"catalog":{"$ref":"#/components/schemas/v2_ExistValue"},"collection":{"$ref":"#/components/schemas/v2_ExistValue"},"glossary":{"$ref":"#/components/schemas/v2_ExistValue"},"document":{"$ref":"#/components/schemas/v2_ExistValue"},"question":{"$ref":"#/components/schemas/v2_ExistValue"},"bi_dashboard":{"$ref":"#/components/schemas/v2_ExistValue"}},"required":["catalog","collection","glossary","document","question","bi_dashboard"],"title":"ExistDict","type":"object"},"v2_ExistValue":{"properties":{"is_empty":{"title":"Is Empty","type":"boolean"}},"required":["is_empty"],"title":"ExistValue","type":"object"}}}}
```

## The v2\_SlackConverstationOut object

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"components":{"schemas":{"v2_SlackConverstationOut":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"}},"required":["id","name"],"title":"SlackConverstationOut","type":"object"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.secoda.co/api/reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.