Questions

Questions asked by data consumers and their associated answers in the workspace. Learn more about questions here.

List Questions

get

/api/v1/question/questions

This endpoint allows you to retrieve a list of questions.

Authorizations

Responses

200

List of questions.

application/json

countintegerOptional

The total count of items returned.

Example: 315

total_pagesintegerOptional

The total number of pages.

Example: 7

400

Bad Request

500

Internal Server Error

get

/api/v1/question/questions

GET /api/v1/question/questions HTTP/1.1
Host: api.secoda.co
Accept: */*

{
  "links": {
    "next": "https://api.secoda.co/resource/all/?page=2",
    "previous": "None"
  },
  "meta": {
    "page": 1,
    "previous_page": "None",
    "next_page": 2
  },
  "count": 315,
  "total_pages": 7,
  "results": [
    {
      "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
      "created_at": "2023-08-16T23:12:53.245493Z",
      "updated_at": "2023-08-16T23:12:53.245507Z",
      "entity_type": "table",
      "native_type": "Dataset",
      "bookmarked_by": [
        "d935a76c-2125-4c30-9389-ef42fa7e23bb",
        "33733f42-8ff7-460b-9e20-50a2133d3bb0",
        "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
      ],
      "icon": "icon-url.png",
      "title": "Sample Table",
      "title_full": "Sample Database.Sample Schema.Sample Table",
      "title_cased": "sampleTable",
      "description": "This is a description for a sample table.",
      "definition": "text",
      "definition_version": 1,
      "multiplayers": [
        "429693a2-a5e7-4525-b413-ece5e96bc5b3",
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
      "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
      "owners": [
        "429693a2-a5e7-4525-b413-ece5e96bc5b3",
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "owners_groups": [
        "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
      ],
      "collections": [
        "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
      ],
      "tags": [
        "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
        "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
      ],
      "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
      "total_usage": 483,
      "published": false,
      "archived": false,
      "pii": true,
      "verified": false,
      "url": "https://example.com/sample-table",
      "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
      "children_count": 2,
      "integration": "ca529385-fbc9-4934-afae-e372affe795b",
      "external_updated_at": "2023-08-16T23:12:53.245507Z",
      "internal_usage": 3,
      "internal_users": [
        "04654d61-4f64-4f08-b697-3915b5137c49"
      ],
      "external_users": [
        "33733f42-8ff7-460b-9e20-50a2133d3bb0"
      ],
      "external_usage": 38,
      "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
      "search_metadata": {
        "cluster": "glue",
        "database": "awsdatacatalog",
        "schema": "secoda-glue",
        "type": "table"
      },
      "sources": [
        "8a3af948-026c-45d6-983d-3873f6156f86"
      ],
      "subscribers": [
        "33733f42-8ff7-460b-9e20-50a2133d3bb0",
        "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
      ],
      "teams": [
        "8680f886-97d2-4f4e-92c8-c80b46a3017d"
      ],
      "stale": false,
      "current_user_permissions": {
        "read": true,
        "write": true,
        "execute": false
      },
      "status": "UNANSWERED",
      "priority": "High",
      "reactions": [
        "👍"
      ],
      "answer": "This is the answer to the question.",
      "assigned_to": "33733f42-8ff7-460b-9e20-50a2133d3bb0",
      "votes_sum": 5,
      "current_user_vote": 4
    }
  ]
}

Create Question

post

/api/v1/question/questions

This endpoint allows you to create a new question. The answer to the question can be set in the answer field, or added as a reply to the question/replies endpoint.

Authorizations

Body

titlestringOptional

The title of the resource.

Example: Sample Title

integrationstringOptional

The integration ID associated with the resource, if one exists.

Example: ca529385-fbc9-4934-afae-e372affe795b

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

entity_typestringOptional

The type of the resource.

Example: glossary

definitionstringOptional

Mark down documentation to be added to the resource.

Example: \n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus

parentstringOptional

The ID of the parent resource. Please keep the resource heirarchy in mind when setting the parent.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

piibooleanOptional

Indicates whether the resource contains personally identifiable information (PII). Values can be -

True
False

Example: false

verifiedbooleanOptional

Indicates whether the resource has been set as verified. Values can be -

True
False

Example: true

publishedbooleanOptional

Indicates if the resource is visible to viewers or not. Values can be -

True
False

Example: true

teamsstring[]Optional

A list of team IDs that the resource belongs to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]

ownersstring[]Optional

A list of owner user IDs for the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

owners_groupsstring[]Optional

A list of owner group IDs for the resource.

Example: ["f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da"]

collectionsstring[]Optional

A list of collection IDs the resource belongs to.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

tagsstring[]Optional

A list of tag IDs associated with the resources.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]

subscribersstring[]Optional

A list of user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.

Example: ["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

assigned_tostringOptional

Represents to whom the question is assigned to.

Example: 33733f42-8ff7-460b-9e20-50a2133d3bb0

Responses

201

Created

application/json

400

Bad Request

500

Internal Server Error

post

/api/v1/question/questions

POST /api/v1/question/questions HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 822

{
  "assigned_to": "33733f42-8ff7-460b-9e20-50a2133d3bb0",
  "title": "Sample Title",
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "description": "This is a description for a sample table.",
  "entity_type": "glossary",
  "definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "pii": false,
  "verified": true,
  "published": true,
  "teams": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260",
    "cca810f1-11c1-4117-bc23-20ae8020897f"
  ],
  "owners": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "owners_groups": [
    "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da"
  ],
  "collections": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "tags": [
    "04654d61-4f64-4f08-b697-3915b5137c49",
    "429693a2-a5e7-4525-b413-ece5e96bc5b3"
  ],
  "subscribers": [
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "status": "UNANSWERED",
  "priority": "High",
  "reactions": [
    "👍"
  ],
  "answer": "This is the answer to the question.",
  "assigned_to": "33733f42-8ff7-460b-9e20-50a2133d3bb0",
  "votes_sum": 5,
  "current_user_vote": 4
}

Get Question

get

/api/v1/question/questions/{question_id}

This endpoint allows you to retrieve a question by its unique identifier (question_id).

Authorizations

Path parameters

question_idstringRequired

The unique identifier of the question

Example: 7795133a-6e36-4ef2-b95a-664babb99b71

Responses

200

Question retrieved successfully

application/json

idstringOptional

The unique identifier of the resource.

Example: d935a76c-2125-4c30-9389-ef42fa7e23bb

created_atstring · date-timeOptional

The timestamp when the resource was created in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245493Z

updated_atstring · date-timeOptional

The timestamp when the resource was last updated in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245507Z

entity_typestringOptional

The type of resource in Secoda.

Example: table

native_typestringOptional

The native type of the resource as it is referred to in the integration.

Example: Dataset

bookmarked_bystring[]Optional

List of member IDs that have bookmarked the resource.

Example: ["d935a76c-2125-4c30-9389-ef42fa7e23bb","33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

iconstringOptional

The icon associated with the resource.

Example: icon-url.png

titlestringOptional

The title of the resource.

Example: Sample Table

title_fullstringOptional

The full title of the resource, including its ancestry.

Example: Sample Database.Sample Schema.Sample Table

title_casedstringOptional

The title in a cased format.

Example: sampleTable

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstring · markdownOptional

The documentation of the resource, written in Mark Down format.

definition_versionintegerOptional

The version of the resource's documentation.

Example: 1

multiplayersstring[]Optional

List of members who have opened or worked with the resource recently.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

multiplayer_last_modified_bystringOptional

The last member who modified this resource.

Example: 429693a2-a5e7-4525-b413-ece5e96bc5b3

multiplayer_last_modifiedstring · date-timeOptional

The timestamp when the multiplayer was last modified in UTC format.

Example: 2023-08-16T23:12:53.245507Z

ownersstring[]Optional

List of owner IDs for the resource.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

owners_groupsstring[]Optional

List of owner group IDs for the resource.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

collectionsstring[]Optional

List of IDs representing the collection(s) that the resource has been added to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260"]

tagsstring[]Optional

List of tag IDs added to the resource.

Example: ["f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2","a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"]

workspace_idstringOptional

The ID of the workspace.

Example: f71585fa-251c-4102-8d81-c97c57c8d435

total_usageintegerOptional

The total usage count for the resource.

Example: 483

publishedbooleanOptional

Indicates if the resource is published and can be seen by Viewers.

Example: false

archivedbooleanOptional

Indicates if the resource is deleted.

Example: false

piibooleanOptional

Indicates if the resource contains Personally Identifiable Information (PII). Values can be -

True
False

Example: true

verifiedbooleanOptional

Indicates if the resource is verified. Values can be -

True
False

Example: false

urlstringOptional

The URL associated with the resource.

Example: https://example.com/sample-table

parentstringOptional

The parent resource's ID.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

children_countintegerOptional

The count of children entities of the resource.

Example: 2

integrationstringOptional

The integration ID associated with the resource.

Example: ca529385-fbc9-4934-afae-e372affe795b

external_updated_atstring · date-timeOptional

The timestamp of the last update for the resource in the source.

Example: 2023-08-16T23:12:53.245507Z

internal_usageintegerOptional

The internal usage count for the resource.

Example: 3

internal_usersstring[]Optional

List of internal user IDs for the resource.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49"]

external_usersstring[]Optional

List of external user IDs for the resource extracted from the integration.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0"]

external_usageintegerOptional

The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.

Example: 38

databuilder_idstringOptional

The databuilder ID associated with the resource. This is a generated field.

Example: b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2

search_metadataobjectOptional

Metadata related to indexing the resource for optimizing search.

Example: {"cluster":"glue","database":"awsdatacatalog","schema":"secoda-glue","type":"table"}

sourcesstring[]Optional

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.

Example: ["8a3af948-026c-45d6-983d-3873f6156f86"]

subscribersstring[]Optional

List of User IDs who subscribe to the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

teamsstring[]Optional

List of team IDs associated with the resource.

Example: ["8680f886-97d2-4f4e-92c8-c80b46a3017d"]

stalebooleanOptional

Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.

Example: false

statusstringOptional

Indicates the status of the question. Values can be -

Answered
Unanswered

Example: UNANSWERED

prioritystringOptional

Indicates the priority of the question or request.

Example: High

reactionsstring[]Optional

Represents the emoji reactions to a question.

Example: ["👍"]

answerstringOptional

Represents the verified answer of the question.

Example: This is the answer to the question.

assigned_tostringOptional

Represents the user whom the question is assigned to.

Example: 33733f42-8ff7-460b-9e20-50a2133d3bb0

votes_sumintegerOptional

Indicates the amount of votes for the quesion.

Example: 5

current_user_voteintegerOptional

Represents the vote number of the current user.

Example: 4

404

Question not found

500

Internal Server Error

get

/api/v1/question/questions/{question_id}

GET /api/v1/question/questions/{question_id} HTTP/1.1
Host: api.secoda.co
Accept: */*

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "status": "UNANSWERED",
  "priority": "High",
  "reactions": [
    "👍"
  ],
  "answer": "This is the answer to the question.",
  "assigned_to": "33733f42-8ff7-460b-9e20-50a2133d3bb0",
  "votes_sum": 5,
  "current_user_vote": 4
}

Delete Question

delete

/api/v1/question/questions/{question_id}

This endpoint allows you to delete a question by its unique identifier (question_id).

Authorizations

Path parameters

question_idstringRequired

The unique identifier of the question to delete

Example: 4272310f-0129-4982-8849-4b20edd3f2d5

Responses

204

Question deleted successfully

404

Question not found

500

Internal Server Error

delete

/api/v1/question/questions/{question_id}

DELETE /api/v1/question/questions/{question_id} HTTP/1.1
Host: api.secoda.co
Accept: */*

No content

Edit Question

patch

/api/v1/question/questions/{question_id}

This endpoint allows you to edit the metadata of a question by its unique identifier (question_id).

Authorizations

Path parameters

question_idstringRequired

The unique identifier of the question to edit

Example: 7795133a-6e36-4ef2-b95a-664babb99b71

Body

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstringOptional

Mark down documentation to be added to the resource.

Example: \n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus

piibooleanOptional

Indicates whether the resource contains personally identifiable information (PII). Values can be -

True
False

Example: false

verifiedbooleanOptional

Indicates whether the table has been set as verified. Values can be -

True
False

Example: true

publishedbooleanOptional

Indicates if the resource is visible to viewers or not. Values can be -

True
False

Example: true

teamsstring[]Optional

A list of team IDs that the resource belongs to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]

ownersstring[]Optional

A list of owner user IDs for the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

collectionsstring[]Optional

A list of collection IDs the resource belongs to.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

tagsstring[]Optional

A list of tag IDs associated with the resources.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]

subscribersstring[]Optional

A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.

Example: ["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

Responses

200

Definition updated successfully

application/json

idstringOptional

The unique identifier of the resource.

Example: d935a76c-2125-4c30-9389-ef42fa7e23bb

created_atstring · date-timeOptional

The timestamp when the resource was created in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245493Z

updated_atstring · date-timeOptional

The timestamp when the resource was last updated in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245507Z

entity_typestringOptional

The type of resource in Secoda.

Example: table

native_typestringOptional

The native type of the resource as it is referred to in the integration.

Example: Dataset

bookmarked_bystring[]Optional

List of member IDs that have bookmarked the resource.

Example: ["d935a76c-2125-4c30-9389-ef42fa7e23bb","33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

iconstringOptional

The icon associated with the resource.

Example: icon-url.png

titlestringOptional

The title of the resource.

Example: Sample Table

title_fullstringOptional

The full title of the resource, including its ancestry.

Example: Sample Database.Sample Schema.Sample Table

title_casedstringOptional

The title in a cased format.

Example: sampleTable

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstring · markdownOptional

The documentation of the resource, written in Mark Down format.

definition_versionintegerOptional

The version of the resource's documentation.

Example: 1

multiplayersstring[]Optional

List of members who have opened or worked with the resource recently.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

multiplayer_last_modified_bystringOptional

The last member who modified this resource.

Example: 429693a2-a5e7-4525-b413-ece5e96bc5b3

multiplayer_last_modifiedstring · date-timeOptional

The timestamp when the multiplayer was last modified in UTC format.

Example: 2023-08-16T23:12:53.245507Z

ownersstring[]Optional

List of owner IDs for the resource.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

owners_groupsstring[]Optional

List of owner group IDs for the resource.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

collectionsstring[]Optional

List of IDs representing the collection(s) that the resource has been added to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260"]

tagsstring[]Optional

List of tag IDs added to the resource.

Example: ["f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2","a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"]

workspace_idstringOptional

The ID of the workspace.

Example: f71585fa-251c-4102-8d81-c97c57c8d435

total_usageintegerOptional

The total usage count for the resource.

Example: 483

publishedbooleanOptional

Indicates if the resource is published and can be seen by Viewers.

Example: false

archivedbooleanOptional

Indicates if the resource is deleted.

Example: false

piibooleanOptional

Indicates if the resource contains Personally Identifiable Information (PII). Values can be -

True
False

Example: true

verifiedbooleanOptional

Indicates if the resource is verified. Values can be -

True
False

Example: false

urlstringOptional

The URL associated with the resource.

Example: https://example.com/sample-table

parentstringOptional

The parent resource's ID.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

children_countintegerOptional

The count of children entities of the resource.

Example: 2

integrationstringOptional

The integration ID associated with the resource.

Example: ca529385-fbc9-4934-afae-e372affe795b

external_updated_atstring · date-timeOptional

The timestamp of the last update for the resource in the source.

Example: 2023-08-16T23:12:53.245507Z

internal_usageintegerOptional

The internal usage count for the resource.

Example: 3

internal_usersstring[]Optional

List of internal user IDs for the resource.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49"]

external_usersstring[]Optional

List of external user IDs for the resource extracted from the integration.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0"]

external_usageintegerOptional

The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.

Example: 38

databuilder_idstringOptional

The databuilder ID associated with the resource. This is a generated field.

Example: b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2

search_metadataobjectOptional

Metadata related to indexing the resource for optimizing search.

Example: {"cluster":"glue","database":"awsdatacatalog","schema":"secoda-glue","type":"table"}

sourcesstring[]Optional

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.

Example: ["8a3af948-026c-45d6-983d-3873f6156f86"]

subscribersstring[]Optional

List of User IDs who subscribe to the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

teamsstring[]Optional

List of team IDs associated with the resource.

Example: ["8680f886-97d2-4f4e-92c8-c80b46a3017d"]

stalebooleanOptional

Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.

Example: false

statusstringOptional

Indicates the status of the question. Values can be -

Answered
Unanswered

Example: UNANSWERED

prioritystringOptional

Indicates the priority of the question or request.

Example: High

reactionsstring[]Optional

Represents the emoji reactions to a question.

Example: ["👍"]

answerstringOptional

Represents the verified answer of the question.

Example: This is the answer to the question.

assigned_tostringOptional

Represents the user whom the question is assigned to.

Example: 33733f42-8ff7-460b-9e20-50a2133d3bb0

votes_sumintegerOptional

Indicates the amount of votes for the quesion.

Example: 5

current_user_voteintegerOptional

Represents the vote number of the current user.

Example: 4

400

Bad Request

404

Question not found

500

Internal Server Error

patch

/api/v1/question/questions/{question_id}

PATCH /api/v1/question/questions/{question_id} HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "description": "This is a description for a sample table.",
  "definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
  "pii": false,
  "verified": true,
  "published": true,
  "teams": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260",
    "cca810f1-11c1-4117-bc23-20ae8020897f"
  ],
  "owners": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "collections": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "tags": [
    "04654d61-4f64-4f08-b697-3915b5137c49",
    "429693a2-a5e7-4525-b413-ece5e96bc5b3"
  ],
  "subscribers": [
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "status": "UNANSWERED",
  "priority": "High",
  "reactions": [
    "👍"
  ],
  "answer": "This is the answer to the question.",
  "assigned_to": "33733f42-8ff7-460b-9e20-50a2133d3bb0",
  "votes_sum": 5,
  "current_user_vote": 4
}

List Question Replies

get

/api/v1/question/replies

This endpoint allows you to retrieve a list of replies. You can optionally filter the replies by question_id using the "question_id" query parameter.

Authorizations

Query parameters

question_idstringOptional

Filter replies by question_id (optional)

Example: 7795133a-6e36-4ef2-b95a-664babb99b71

Responses

200

List of replies.

application/json

countintegerOptional

The total count of items returned.

Example: 315

total_pagesintegerOptional

The total number of pages.

Example: 7

400

Bad Request

500

Internal Server Error

get

/api/v1/question/replies

GET /api/v1/question/replies HTTP/1.1
Host: api.secoda.co
Accept: */*

{
  "links": {
    "next": "https://api.secoda.co/resource/all/?page=2",
    "previous": "None"
  },
  "meta": {
    "page": 1,
    "previous_page": "None",
    "next_page": 2
  },
  "count": 315,
  "total_pages": 7,
  "results": [
    {
      "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
      "created_at": "2023-08-16T23:12:53.245493Z",
      "updated_at": "2023-08-16T23:12:53.245507Z",
      "entity_type": "table",
      "native_type": "Dataset",
      "bookmarked_by": [
        "d935a76c-2125-4c30-9389-ef42fa7e23bb",
        "33733f42-8ff7-460b-9e20-50a2133d3bb0",
        "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
      ],
      "icon": "icon-url.png",
      "title": "Sample Table",
      "title_full": "Sample Database.Sample Schema.Sample Table",
      "title_cased": "sampleTable",
      "description": "This is a description for a sample table.",
      "definition": "text",
      "definition_version": 1,
      "multiplayers": [
        "429693a2-a5e7-4525-b413-ece5e96bc5b3",
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
      "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
      "owners": [
        "429693a2-a5e7-4525-b413-ece5e96bc5b3",
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "owners_groups": [
        "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
      ],
      "collections": [
        "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
      ],
      "tags": [
        "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
        "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
      ],
      "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
      "total_usage": 483,
      "published": false,
      "archived": false,
      "pii": true,
      "verified": false,
      "url": "https://example.com/sample-table",
      "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
      "children_count": 2,
      "integration": "ca529385-fbc9-4934-afae-e372affe795b",
      "external_updated_at": "2023-08-16T23:12:53.245507Z",
      "internal_usage": 3,
      "internal_users": [
        "04654d61-4f64-4f08-b697-3915b5137c49"
      ],
      "external_users": [
        "33733f42-8ff7-460b-9e20-50a2133d3bb0"
      ],
      "external_usage": 38,
      "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
      "search_metadata": {
        "cluster": "glue",
        "database": "awsdatacatalog",
        "schema": "secoda-glue",
        "type": "table"
      },
      "sources": [
        "8a3af948-026c-45d6-983d-3873f6156f86"
      ],
      "subscribers": [
        "33733f42-8ff7-460b-9e20-50a2133d3bb0",
        "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
      ],
      "teams": [
        "8680f886-97d2-4f4e-92c8-c80b46a3017d"
      ],
      "stale": false,
      "current_user_permissions": {
        "read": true,
        "write": true,
        "execute": false
      },
      "reactions": [
        "👍"
      ],
      "accepted_answer": false
    }
  ]
}

Create Question Reply

post

/api/v1/question/replies

This endpoint allows you to create a new reply to a specified question (indicated by the parent_id).

Authorizations

Body

definitionstringOptional

The answer of the reply

Example: Replying to the question

accepted_answerbooleanOptional

Indicates if the answer is accepted or not. Values can be -

True
False

Example: false

parentstringOptional

The unique identifier of the parent question

Example: 7795133a-6e36-4ef2-b95a-664babb99b71

ownersstring[]Optional

Defines the UUIDs that are the owners of the replies.

Example: 33733f42-8ff7-460b-9e20-50a2133d3bb0

Responses

201

Created

application/json

400

Bad Request

500

Internal Server Error

post

/api/v1/question/replies

POST /api/v1/question/replies HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "definition": "Replying to the question",
  "accepted_answer": false,
  "parent": "7795133a-6e36-4ef2-b95a-664babb99b71",
  "owners": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ]
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "reactions": [
    "👍"
  ],
  "accepted_answer": false
}

Get Question Reply

get

/api/v1/question/replies/{reply_id}

This endpoint allows you to retrieve a reply by its unique identifier (reply_id).

Authorizations

Path parameters

reply_idstringRequired

The unique identifier of the reply

Example: 47f9d5ab-4ae1-4eea-a8b8-6d3847829b3f

Responses

200

Reply retrieved successfully

application/json

idstringOptional

The unique identifier of the resource.

Example: d935a76c-2125-4c30-9389-ef42fa7e23bb

created_atstring · date-timeOptional

The timestamp when the resource was created in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245493Z

updated_atstring · date-timeOptional

The timestamp when the resource was last updated in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245507Z

entity_typestringOptional

The type of resource in Secoda.

Example: table

native_typestringOptional

The native type of the resource as it is referred to in the integration.

Example: Dataset

bookmarked_bystring[]Optional

List of member IDs that have bookmarked the resource.

Example: ["d935a76c-2125-4c30-9389-ef42fa7e23bb","33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

iconstringOptional

The icon associated with the resource.

Example: icon-url.png

titlestringOptional

The title of the resource.

Example: Sample Table

title_fullstringOptional

The full title of the resource, including its ancestry.

Example: Sample Database.Sample Schema.Sample Table

title_casedstringOptional

The title in a cased format.

Example: sampleTable

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstring · markdownOptional

The documentation of the resource, written in Mark Down format.

definition_versionintegerOptional

The version of the resource's documentation.

Example: 1

multiplayersstring[]Optional

List of members who have opened or worked with the resource recently.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

multiplayer_last_modified_bystringOptional

The last member who modified this resource.

Example: 429693a2-a5e7-4525-b413-ece5e96bc5b3

multiplayer_last_modifiedstring · date-timeOptional

The timestamp when the multiplayer was last modified in UTC format.

Example: 2023-08-16T23:12:53.245507Z

ownersstring[]Optional

List of owner IDs for the resource.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

owners_groupsstring[]Optional

List of owner group IDs for the resource.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

collectionsstring[]Optional

List of IDs representing the collection(s) that the resource has been added to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260"]

tagsstring[]Optional

List of tag IDs added to the resource.

Example: ["f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2","a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"]

workspace_idstringOptional

The ID of the workspace.

Example: f71585fa-251c-4102-8d81-c97c57c8d435

total_usageintegerOptional

The total usage count for the resource.

Example: 483

publishedbooleanOptional

Indicates if the resource is published and can be seen by Viewers.

Example: false

archivedbooleanOptional

Indicates if the resource is deleted.

Example: false

piibooleanOptional

Indicates if the resource contains Personally Identifiable Information (PII). Values can be -

True
False

Example: true

verifiedbooleanOptional

Indicates if the resource is verified. Values can be -

True
False

Example: false

urlstringOptional

The URL associated with the resource.

Example: https://example.com/sample-table

parentstringOptional

The parent resource's ID.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

children_countintegerOptional

The count of children entities of the resource.

Example: 2

integrationstringOptional

The integration ID associated with the resource.

Example: ca529385-fbc9-4934-afae-e372affe795b

external_updated_atstring · date-timeOptional

The timestamp of the last update for the resource in the source.

Example: 2023-08-16T23:12:53.245507Z

internal_usageintegerOptional

The internal usage count for the resource.

Example: 3

internal_usersstring[]Optional

List of internal user IDs for the resource.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49"]

external_usersstring[]Optional

List of external user IDs for the resource extracted from the integration.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0"]

external_usageintegerOptional

The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.

Example: 38

databuilder_idstringOptional

The databuilder ID associated with the resource. This is a generated field.

Example: b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2

search_metadataobjectOptional

Metadata related to indexing the resource for optimizing search.

Example: {"cluster":"glue","database":"awsdatacatalog","schema":"secoda-glue","type":"table"}

sourcesstring[]Optional

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.

Example: ["8a3af948-026c-45d6-983d-3873f6156f86"]

subscribersstring[]Optional

List of User IDs who subscribe to the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

teamsstring[]Optional

List of team IDs associated with the resource.

Example: ["8680f886-97d2-4f4e-92c8-c80b46a3017d"]

stalebooleanOptional

Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.

Example: false

reactionsstring[]Optional

Represents the emoji reactions to a question.

Example: ["👍"]

accepted_answerbooleanOptional

Indicates if the answer is accepted or not. Values can be -

True
False

Example: false

404

Reply not found

500

Internal Server Error

get

/api/v1/question/replies/{reply_id}

GET /api/v1/question/replies/{reply_id} HTTP/1.1
Host: api.secoda.co
Accept: */*

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "reactions": [
    "👍"
  ],
  "accepted_answer": false
}

Delete Question Reply

delete

/api/v1/question/replies/{reply_id}

This endpoint allows you to delete a reply by its unique identifier (reply_id).

Authorizations

Path parameters

reply_idstringRequired

The unique identifier of the reply to delete

Example: 47f9d5ab-4ae1-4eea-a8b8-6d3847829b3f

Responses

204

Reply deleted successfully

404

Reply not found

500

Internal Server Error

delete

/api/v1/question/replies/{reply_id}

DELETE /api/v1/question/replies/{reply_id} HTTP/1.1
Host: api.secoda.co
Accept: */*

No content

Edit Question Reply

patch

/api/v1/question/replies/{reply_id}

This endpoint allows you to edit the content of a reply by its unique identifier (reply_id). You can also use this endoint to set this reply as the accepted answer.

Authorizations

Path parameters

reply_idstringRequired

The unique identifier of the reply to edit

Example: 47f9d5ab-4ae1-4eea-a8b8-6d3847829b3f

Body

definitionstringOptional

The updated definition for the reply

Example: Changing the answer.

accepted_answerbooleanOptional

Indicates if the answer is accepted or not. Values can be -

True
False

Example: false

Responses

200

Definition updated successfully

application/json

idstringOptional

The unique identifier of the resource.

Example: d935a76c-2125-4c30-9389-ef42fa7e23bb

created_atstring · date-timeOptional

The timestamp when the resource was created in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245493Z

updated_atstring · date-timeOptional

The timestamp when the resource was last updated in Secoda in UTC format.

Example: 2023-08-16T23:12:53.245507Z

entity_typestringOptional

The type of resource in Secoda.

Example: table

native_typestringOptional

The native type of the resource as it is referred to in the integration.

Example: Dataset

bookmarked_bystring[]Optional

List of member IDs that have bookmarked the resource.

Example: ["d935a76c-2125-4c30-9389-ef42fa7e23bb","33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

iconstringOptional

The icon associated with the resource.

Example: icon-url.png

titlestringOptional

The title of the resource.

Example: Sample Table

title_fullstringOptional

The full title of the resource, including its ancestry.

Example: Sample Database.Sample Schema.Sample Table

title_casedstringOptional

The title in a cased format.

Example: sampleTable

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstring · markdownOptional

The documentation of the resource, written in Mark Down format.

definition_versionintegerOptional

The version of the resource's documentation.

Example: 1

multiplayersstring[]Optional

List of members who have opened or worked with the resource recently.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

multiplayer_last_modified_bystringOptional

The last member who modified this resource.

Example: 429693a2-a5e7-4525-b413-ece5e96bc5b3

multiplayer_last_modifiedstring · date-timeOptional

The timestamp when the multiplayer was last modified in UTC format.

Example: 2023-08-16T23:12:53.245507Z

ownersstring[]Optional

List of owner IDs for the resource.

Example: ["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]

owners_groupsstring[]Optional

List of owner group IDs for the resource.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

collectionsstring[]Optional

List of IDs representing the collection(s) that the resource has been added to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260"]

tagsstring[]Optional

List of tag IDs added to the resource.

Example: ["f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2","a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"]

workspace_idstringOptional

The ID of the workspace.

Example: f71585fa-251c-4102-8d81-c97c57c8d435

total_usageintegerOptional

The total usage count for the resource.

Example: 483

publishedbooleanOptional

Indicates if the resource is published and can be seen by Viewers.

Example: false

archivedbooleanOptional

Indicates if the resource is deleted.

Example: false

piibooleanOptional

Indicates if the resource contains Personally Identifiable Information (PII). Values can be -

True
False

Example: true

verifiedbooleanOptional

Indicates if the resource is verified. Values can be -

True
False

Example: false

urlstringOptional

The URL associated with the resource.

Example: https://example.com/sample-table

parentstringOptional

The parent resource's ID.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

children_countintegerOptional

The count of children entities of the resource.

Example: 2

integrationstringOptional

The integration ID associated with the resource.

Example: ca529385-fbc9-4934-afae-e372affe795b

external_updated_atstring · date-timeOptional

The timestamp of the last update for the resource in the source.

Example: 2023-08-16T23:12:53.245507Z

internal_usageintegerOptional

The internal usage count for the resource.

Example: 3

internal_usersstring[]Optional

List of internal user IDs for the resource.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49"]

external_usersstring[]Optional

List of external user IDs for the resource extracted from the integration.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0"]

external_usageintegerOptional

The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.

Example: 38

databuilder_idstringOptional

The databuilder ID associated with the resource. This is a generated field.

Example: b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2

search_metadataobjectOptional

Metadata related to indexing the resource for optimizing search.

Example: {"cluster":"glue","database":"awsdatacatalog","schema":"secoda-glue","type":"table"}

sourcesstring[]Optional

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.

Example: ["8a3af948-026c-45d6-983d-3873f6156f86"]

subscribersstring[]Optional

List of User IDs who subscribe to the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

teamsstring[]Optional

List of team IDs associated with the resource.

Example: ["8680f886-97d2-4f4e-92c8-c80b46a3017d"]

stalebooleanOptional

Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.

Example: false

reactionsstring[]Optional

Represents the emoji reactions to a question.

Example: ["👍"]

accepted_answerbooleanOptional

Indicates if the answer is accepted or not. Values can be -

True
False

Example: false

400

Bad Request

404

Reply not found

500

Internal Server Error

patch

/api/v1/question/replies/{reply_id}

PATCH /api/v1/question/replies/{reply_id} HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "definition": "Changing the answer.",
  "accepted_answer": false
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  },
  "reactions": [
    "👍"
  ],
  "accepted_answer": false
}

Last updated 30 minutes ago

Was this helpful?

hashtagList Questions

hashtagCreate Question

hashtagGet Question

hashtagDelete Question

hashtagEdit Question

hashtagList Question Replies

hashtagCreate Question Reply

hashtagGet Question Reply

hashtagDelete Question Reply

hashtagEdit Question Reply

List Questions

Create Question

Get Question

Delete Question

Edit Question

List Question Replies

Create Question Reply

Get Question Reply

Delete Question Reply

Edit Question Reply