Retrieve SQL from segment rule

Retrieve a SQL from a segment rule.

SecurityTdApikeyAuth
Request
path Parameters
audienceId
required
integer <int64>

Master Segment id of the segment

Request Body schema: application/json
required

Segment parameters to create

format
string
Value: "sql"
realtime
boolean
Deprecated

use kind instead

kind
integer

0: batch, 1: realtime, 2: funnel_stage

rule
object
object

required if creating segment as a rule of funnel_stage

Responses
200

batch segment query

400

Given parameters are not valid

401

Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource was not found

4XX

There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

post/audiences/{audienceId}/segments/query
Request samples
application/json
{
  • "format": "sql",
  • "realtime": true,
  • "kind": 0,
  • "rule": { },
  • "funnel_stage": {
    }
}
Response samples
application/json
{
  • "sql": "string",
  • "statement": { },
  • "batch_workflows": { }
}