Save

Save

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/reporting/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "displayName": "<string>",
  "prompt": "<string>",
  "surfaceId": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/reporting/reports"

payload = {
    "conversationId": "<string>",
    "displayName": "<string>",
    "prompt": "<string>",
    "surfaceId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversationId: '<string>',
    displayName: '<string>',
    prompt: '<string>',
    surfaceId: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/reporting/reports', 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://{tenantDomain}.conductor.one/api/v1/reporting/reports",
  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([
    'conversationId' => '<string>',
    'displayName' => '<string>',
    'prompt' => '<string>',
    'surfaceId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{tenantDomain}.conductor.one/api/v1/reporting/reports"

	payload := strings.NewReader("{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{tenantDomain}.conductor.one/api/v1/reporting/reports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/reporting/reports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "report": {
    "createdAt": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "displayName": "<string>",
    "id": "<string>",
    "latestRunId": "<string>",
    "latestSuccessfulRunId": "<string>",
    "parameterSchema": {},
    "parameterValues": {},
    "program": {
      "commitId": "<string>",
      "functionId": "<string>",
      "plannedFromPrompt": "<string>"
    },
    "prompt": "<string>",
    "tenantId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

POST

api

reporting

reports

Save

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/reporting/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "displayName": "<string>",
  "prompt": "<string>",
  "surfaceId": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/reporting/reports"

payload = {
    "conversationId": "<string>",
    "displayName": "<string>",
    "prompt": "<string>",
    "surfaceId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversationId: '<string>',
    displayName: '<string>',
    prompt: '<string>',
    surfaceId: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/reporting/reports', 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://{tenantDomain}.conductor.one/api/v1/reporting/reports",
  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([
    'conversationId' => '<string>',
    'displayName' => '<string>',
    'prompt' => '<string>',
    'surfaceId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{tenantDomain}.conductor.one/api/v1/reporting/reports"

	payload := strings.NewReader("{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{tenantDomain}.conductor.one/api/v1/reporting/reports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/reporting/reports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conversationId\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"surfaceId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "report": {
    "createdAt": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "displayName": "<string>",
    "id": "<string>",
    "latestRunId": "<string>",
    "latestSuccessfulRunId": "<string>",
    "parameterSchema": {},
    "parameterValues": {},
    "program": {
      "commitId": "<string>",
      "functionId": "<string>",
      "plannedFromPrompt": "<string>"
    },
    "prompt": "<string>",
    "tenantId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization

string

header

required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The ReportingServiceSaveRequest message.

conversationId

string

The conversation and surface are both required to address a rendered surface; neither identifies one alone.

displayName

string

The displayName field.

prompt

string

The question this surface answered. The surface records its program but not the words behind it, so the caller supplies them; without it the report has nothing to compare against when deciding its program has gone stale.

surfaceId

string

The surfaceId field.

Response

200 - application/json

Successful response

The ReportingServiceSaveResponse message.

report

Report · object | null

Report is a saved report: the question, the program that answers it, and the parameters a re-run may vary.

Show child attributes

⌘I

Welcome

Endpoints

Authorizations

Body

Response