Skip to main content
POST
/
v4
/
accounts
/
{accountId}
/
drafts
/
{draftId}
/
insights
Request content insights
curl --request POST \
  --url 'https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "insight": {
    "input": {
      "topic": {
        "phrases": [
          "data integration"
        ],
        "rankSourceId": 1,
        "webPropertyId": 1,
        "competitorUrls": [
          "https://www.example.com/data-integration",
          "https://www.example.org/guides/data-integration-tools",
          "https://www.example.net/data-integration-platform",
          "https://www.example.com/blog/etl-vs-elt",
          "https://www.example.org/data-pipelines"
        ]
      }
    },
    "request": {
      "insights": [
        "PAA_INSIGHT",
        "BODY_CONTENT_COMMON",
        "CONTENT_ANALYSIS_INSIGHT",
        "HTML_HEADING1_COMMON",
        "HTML_HEADING2_COMMON",
        "HTML_HEADING3_COMMON",
        "HTML_META_DESCRIPTION_COMMON",
        "HTML_TITLE_COMMON",
        "CONTENT_LENGTH_INSIGHT",
        "READABILITY_INSIGHT",
        "OBJECTIVE_INSIGHT",
        "AUDIENCE_INSIGHT",
        "JOURNEY_STAGE_INSIGHT",
        "CONTENT_TYPE_INSIGHT",
        "SUBTOPIC_INSIGHT",
        "OPPORTUNITIES_SNIPPET",
        "MSV_SNIPPET"
      ]
    }
  }
}
'
import requests

url = "https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig="

payload = { "insight": {
        "input": { "topic": {
                "phrases": ["data integration"],
                "rankSourceId": 1,
                "webPropertyId": 1,
                "competitorUrls": ["https://www.example.com/data-integration", "https://www.example.org/guides/data-integration-tools", "https://www.example.net/data-integration-platform", "https://www.example.com/blog/etl-vs-elt", "https://www.example.org/data-pipelines"]
            } },
        "request": { "insights": ["PAA_INSIGHT", "BODY_CONTENT_COMMON", "CONTENT_ANALYSIS_INSIGHT", "HTML_HEADING1_COMMON", "HTML_HEADING2_COMMON", "HTML_HEADING3_COMMON", "HTML_META_DESCRIPTION_COMMON", "HTML_TITLE_COMMON", "CONTENT_LENGTH_INSIGHT", "READABILITY_INSIGHT", "OBJECTIVE_INSIGHT", "AUDIENCE_INSIGHT", "JOURNEY_STAGE_INSIGHT", "CONTENT_TYPE_INSIGHT", "SUBTOPIC_INSIGHT", "OPPORTUNITIES_SNIPPET", "MSV_SNIPPET"] }
    } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    insight: {
      input: {
        topic: {
          phrases: ['data integration'],
          rankSourceId: 1,
          webPropertyId: 1,
          competitorUrls: [
            'https://www.example.com/data-integration',
            'https://www.example.org/guides/data-integration-tools',
            'https://www.example.net/data-integration-platform',
            'https://www.example.com/blog/etl-vs-elt',
            'https://www.example.org/data-pipelines'
          ]
        }
      },
      request: {
        insights: [
          'PAA_INSIGHT',
          'BODY_CONTENT_COMMON',
          'CONTENT_ANALYSIS_INSIGHT',
          'HTML_HEADING1_COMMON',
          'HTML_HEADING2_COMMON',
          'HTML_HEADING3_COMMON',
          'HTML_META_DESCRIPTION_COMMON',
          'HTML_TITLE_COMMON',
          'CONTENT_LENGTH_INSIGHT',
          'READABILITY_INSIGHT',
          'OBJECTIVE_INSIGHT',
          'AUDIENCE_INSIGHT',
          'JOURNEY_STAGE_INSIGHT',
          'CONTENT_TYPE_INSIGHT',
          'SUBTOPIC_INSIGHT',
          'OPPORTUNITIES_SNIPPET',
          'MSV_SNIPPET'
        ]
      }
    }
  })
};

fetch('https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'insight' => [
        'input' => [
                'topic' => [
                                'phrases' => [
                                                                'data integration'
                                ],
                                'rankSourceId' => 1,
                                'webPropertyId' => 1,
                                'competitorUrls' => [
                                                                'https://www.example.com/data-integration',
                                                                'https://www.example.org/guides/data-integration-tools',
                                                                'https://www.example.net/data-integration-platform',
                                                                'https://www.example.com/blog/etl-vs-elt',
                                                                'https://www.example.org/data-pipelines'
                                ]
                ]
        ],
        'request' => [
                'insights' => [
                                'PAA_INSIGHT',
                                'BODY_CONTENT_COMMON',
                                'CONTENT_ANALYSIS_INSIGHT',
                                'HTML_HEADING1_COMMON',
                                'HTML_HEADING2_COMMON',
                                'HTML_HEADING3_COMMON',
                                'HTML_META_DESCRIPTION_COMMON',
                                'HTML_TITLE_COMMON',
                                'CONTENT_LENGTH_INSIGHT',
                                'READABILITY_INSIGHT',
                                'OBJECTIVE_INSIGHT',
                                'AUDIENCE_INSIGHT',
                                'JOURNEY_STAGE_INSIGHT',
                                'CONTENT_TYPE_INSIGHT',
                                'SUBTOPIC_INSIGHT',
                                'OPPORTUNITIES_SNIPPET',
                                'MSV_SNIPPET'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig="

	payload := strings.NewReader("{\n  \"insight\": {\n    \"input\": {\n      \"topic\": {\n        \"phrases\": [\n          \"data integration\"\n        ],\n        \"rankSourceId\": 1,\n        \"webPropertyId\": 1,\n        \"competitorUrls\": [\n          \"https://www.example.com/data-integration\",\n          \"https://www.example.org/guides/data-integration-tools\",\n          \"https://www.example.net/data-integration-platform\",\n          \"https://www.example.com/blog/etl-vs-elt\",\n          \"https://www.example.org/data-pipelines\"\n        ]\n      }\n    },\n    \"request\": {\n      \"insights\": [\n        \"PAA_INSIGHT\",\n        \"BODY_CONTENT_COMMON\",\n        \"CONTENT_ANALYSIS_INSIGHT\",\n        \"HTML_HEADING1_COMMON\",\n        \"HTML_HEADING2_COMMON\",\n        \"HTML_HEADING3_COMMON\",\n        \"HTML_META_DESCRIPTION_COMMON\",\n        \"HTML_TITLE_COMMON\",\n        \"CONTENT_LENGTH_INSIGHT\",\n        \"READABILITY_INSIGHT\",\n        \"OBJECTIVE_INSIGHT\",\n        \"AUDIENCE_INSIGHT\",\n        \"JOURNEY_STAGE_INSIGHT\",\n        \"CONTENT_TYPE_INSIGHT\",\n        \"SUBTOPIC_INSIGHT\",\n        \"OPPORTUNITIES_SNIPPET\",\n        \"MSV_SNIPPET\"\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig=")
  .header("Content-Type", "application/json")
  .body("{\n  \"insight\": {\n    \"input\": {\n      \"topic\": {\n        \"phrases\": [\n          \"data integration\"\n        ],\n        \"rankSourceId\": 1,\n        \"webPropertyId\": 1,\n        \"competitorUrls\": [\n          \"https://www.example.com/data-integration\",\n          \"https://www.example.org/guides/data-integration-tools\",\n          \"https://www.example.net/data-integration-platform\",\n          \"https://www.example.com/blog/etl-vs-elt\",\n          \"https://www.example.org/data-pipelines\"\n        ]\n      }\n    },\n    \"request\": {\n      \"insights\": [\n        \"PAA_INSIGHT\",\n        \"BODY_CONTENT_COMMON\",\n        \"CONTENT_ANALYSIS_INSIGHT\",\n        \"HTML_HEADING1_COMMON\",\n        \"HTML_HEADING2_COMMON\",\n        \"HTML_HEADING3_COMMON\",\n        \"HTML_META_DESCRIPTION_COMMON\",\n        \"HTML_TITLE_COMMON\",\n        \"CONTENT_LENGTH_INSIGHT\",\n        \"READABILITY_INSIGHT\",\n        \"OBJECTIVE_INSIGHT\",\n        \"AUDIENCE_INSIGHT\",\n        \"JOURNEY_STAGE_INSIGHT\",\n        \"CONTENT_TYPE_INSIGHT\",\n        \"SUBTOPIC_INSIGHT\",\n        \"OPPORTUNITIES_SNIPPET\",\n        \"MSV_SNIPPET\"\n      ]\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.conductor.com/v4/accounts/{accountId}/drafts/{draftId}/insights?apiKey=&sig=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"insight\": {\n    \"input\": {\n      \"topic\": {\n        \"phrases\": [\n          \"data integration\"\n        ],\n        \"rankSourceId\": 1,\n        \"webPropertyId\": 1,\n        \"competitorUrls\": [\n          \"https://www.example.com/data-integration\",\n          \"https://www.example.org/guides/data-integration-tools\",\n          \"https://www.example.net/data-integration-platform\",\n          \"https://www.example.com/blog/etl-vs-elt\",\n          \"https://www.example.org/data-pipelines\"\n        ]\n      }\n    },\n    \"request\": {\n      \"insights\": [\n        \"PAA_INSIGHT\",\n        \"BODY_CONTENT_COMMON\",\n        \"CONTENT_ANALYSIS_INSIGHT\",\n        \"HTML_HEADING1_COMMON\",\n        \"HTML_HEADING2_COMMON\",\n        \"HTML_HEADING3_COMMON\",\n        \"HTML_META_DESCRIPTION_COMMON\",\n        \"HTML_TITLE_COMMON\",\n        \"CONTENT_LENGTH_INSIGHT\",\n        \"READABILITY_INSIGHT\",\n        \"OBJECTIVE_INSIGHT\",\n        \"AUDIENCE_INSIGHT\",\n        \"JOURNEY_STAGE_INSIGHT\",\n        \"CONTENT_TYPE_INSIGHT\",\n        \"SUBTOPIC_INSIGHT\",\n        \"OPPORTUNITIES_SNIPPET\",\n        \"MSV_SNIPPET\"\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "code": "<string>",
  "message": "<string>"
}
{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}
{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

Authorizations

​
apiKey
string
query
required

API Key as a query parameter

​
sig
string
query
required

Request signature computed using API key and secret. Valid for 5 minutes after creation.

Path Parameters

​
accountId
integer
required

Account identifier

​
draftId
string<uuid>
required

Draft identifier

Body

application/json
​
insight
object

Response

Insights request accepted