post https://api.similarweb.com/batch/v4/integration/create-table
Creates a permanent AWS S3 or Snowflake table. Note that before creating a table, you must create an integration.
Note:
Before creating a table, you need to create either a Snowflake integration or an AWS S3 integration.
Request Overview:
This endpoint involves a two-step process:
- Create the Table: Use this request to create a table for storing data.
- Request a Report: Once the table is created, you can request new reports and append the data to the previously created table.
Note:
Both the request for creating a table (step 1) and the request for appending data (step 2) use similar parameters but have different URLs.
Step 1: Creates the table and pushes the requested data.
Step 2: Recurring requests to append new data to the created table.
Request Body Params
The request body follows the same structure as the "Request Report" endpoint but focuses on the delivery_information section.
| Property | Description | Type |
|---|---|---|
| report_query | Report query parameters. | ReportQuery |
| delivery_information | Delivery information parameters. | DeliveryInformation |
DeliveryInformation Object
| Property | Description | Type |
|---|---|---|
| delivery_method | Set the Delivery Method. | Enum[bucket_access,snowflake] |
| response_format | Mandatory only for "download_link" and "bucket_access" delivery methods. Set the File format of the generated report. | Enum[json,csv,parquet,orc] |
| webhook_url | Optional. Set a webhook url to trigger when the report status is changed. | String |
| delivery_method_params | Only relevant for delivery methods - "snowflake" and "bucket_access". Set delivery method configurations. | DeliveryMethodPropsRequest |
DeliveryMethodPropsRequest Object
| Property | Description | Type |
|---|---|---|
| integration_name | Optional. Only relevant in case of integration setup. see s3-setup or snowflake-setup | String |
| table_name | Mandatory. Pushes the data into a specific table. | String |
| retention_days | Optional. Specifies how long data is retained, with a default of 30 days. Can be set to 1, 30, 60, 180, or 365 days. | Integer |
| num_of_files | Optional. Relevant only for delivery_method "bucket_access". Sets the number of generated files. must be greater then zero. | String |
| write_mode | Optional. Accepted value: 'overwrite' - used when working with an S3 table to replace data for specific dates. | Strin |