Index dimension table

POST 
https://app.mitzu.io/api/v1/projects/:project_id/dimension-tables/:dimension_table_id/index

Triggers indexing of the selected dimension table

Request

Path Parameters

project_id stringrequired

The ID of the project

dimension_table_id stringrequired

The ID of the dimension table

Responses

200

OK

application/json

Schema

Schema

idstring

Unique ID of the task

statestring

Possible values: [queued, running, finished, cancelled]

Example (auto)

{
  "id": "string",
  "state": "queued"
}

401

The API key header is either missing or an invalid API key is given

404

Not Found

application/json

Schema

Schema

messagestring
Example: Project not found

Example (auto)

{
  "message": "Project not found"
}

405

The requested HTTP method is not allowed.

429

Too many requests sent with the same API key. Up to 10 requests can be sent within 1 second.

Authorization: x-mitzu-api-key

name: x-mitzu-api-keytype: apiKeydescription: ## API Key

You can generate a new API key on the Account Settings -> API keys page.
in: header

• python
• curl
• http
• java
• go

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("app.mitzu.io")
payload = ''
headers = {
  'Accept': 'application/json',
  'x-mitzu-api-key': '<x-mitzu-api-key>'
}
conn.request("POST", "/api/v1/projects/:project_id/dimension-tables/:dimension_table_id/index", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://app.mitzu.io/api/v1

Auth

MitzuApiKey

Parameters

project_id — pathrequired

dimension_table_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!