start_run
Start a social analysis run in a workspace. Set keyword-source pairs, optionally product/competitor ASINs to correlate with sales.
Instructions
Starts an analysis run in the given workspace. This is the entry point of the workflow.
Save data.token from the 202 response, wait for succeeded via read_run_status, then call the result endpoints.
social_queries: one row per (keyword, source) pair. Repeat rows to search multiple keywords and/or platforms.Set
product_id/competitor_asinsto enable correlation between social metrics and EC sales (read_ec_results owned / competitor). Omit for social-only analysis.If a run is already running for the tenant, returns 429 (one concurrent run max). Wait for the prior run to finish.
Invalid conditions (e.g. a bad date) return 422.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date_to | No | End date of the analysis period (YYYY-MM-DD). | |
| date_from | No | Start date of the analysis period (YYYY-MM-DD). | |
| product_id | No | Your product ID. Set to enable correlation between social metrics and EC performance (read_ec_results owned). Optional. | |
| workspace_id | Yes | Target workspace ID (from create_workspace / list_workspaces). | |
| social_queries | No | One row per (keyword, source) pair. Repeat rows to search multiple keywords and/or platforms. | |
| competitor_asins | No | Array of competitor Amazon ASINs. Used to fetch the competitor dataset (read_ec_results competitor). Optional. | |
| japanese_posts_only | No | Optional. Defaults to "1"; keep only posts detected as Japanese from post text or hashtags after fetching. | 1 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | An analysis job. Identified by token; result endpoints become available once status is succeeded. |