Insights

curl --request POST \
  --url https://{host}/api/projects/insights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "<string>",
  "metric": "",
  "cohort": "",
  "mode": "final",
  "direction": "<string>",
  "run_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://{host}/api/projects/insights"

payload = {
    "project": "<string>",
    "metric": "",
    "cohort": "",
    "mode": "final",
    "direction": "<string>",
    "run_ids": ["<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({
    project: '<string>',
    metric: '',
    cohort: '',
    mode: 'final',
    direction: '<string>',
    run_ids: ['<string>']
  })
};

fetch('https://{host}/api/projects/insights', 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://{host}/api/projects/insights",
  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([
    'project' => '<string>',
    'metric' => '',
    'cohort' => '',
    'mode' => 'final',
    'direction' => '<string>',
    'run_ids' => [
        '<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://{host}/api/projects/insights"

	payload := strings.NewReader("{\n  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\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://{host}/api/projects/insights")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/projects/insights")

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  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\n}"

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

{
  "scope_count": 123,
  "cohort_count": 123,
  "eligible_count": 123,
  "measured_count": 123,
  "cohorts": [
    {
      "value": "<string>",
      "label": "<string>",
      "count": 0
    }
  ],
  "cohort": "<string>",
  "metrics": [
    {
      "value": "<string>",
      "label": "<string>",
      "count": 0
    }
  ],
  "metric": "<string>",
  "direction": "<string>",
  "display": "<string>",
  "mode": "<string>",
  "points": [
    {
      "run_id": "<string>",
      "job_id": "<string>",
      "name": "<string>",
      "value": 123,
      "step": 123
    }
  ],
  "parameters": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ],
      "distinct": 123,
      "present": 123,
      "minimum": 123,
      "maximum": 123,
      "best_value": "<string>"
    }
  ],
  "fixed_parameters": 123,
  "best": {
    "run_id": "<string>",
    "job_id": "<string>",
    "name": "<string>",
    "value": 123,
    "step": 123
  },
  "minimum": 123,
  "maximum": 123,
  "median": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

projects

insights

Insights

curl --request POST \
  --url https://{host}/api/projects/insights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "<string>",
  "metric": "",
  "cohort": "",
  "mode": "final",
  "direction": "<string>",
  "run_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://{host}/api/projects/insights"

payload = {
    "project": "<string>",
    "metric": "",
    "cohort": "",
    "mode": "final",
    "direction": "<string>",
    "run_ids": ["<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({
    project: '<string>',
    metric: '',
    cohort: '',
    mode: 'final',
    direction: '<string>',
    run_ids: ['<string>']
  })
};

fetch('https://{host}/api/projects/insights', 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://{host}/api/projects/insights",
  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([
    'project' => '<string>',
    'metric' => '',
    'cohort' => '',
    'mode' => 'final',
    'direction' => '<string>',
    'run_ids' => [
        '<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://{host}/api/projects/insights"

	payload := strings.NewReader("{\n  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\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://{host}/api/projects/insights")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/projects/insights")

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  \"project\": \"<string>\",\n  \"metric\": \"\",\n  \"cohort\": \"\",\n  \"mode\": \"final\",\n  \"direction\": \"<string>\",\n  \"run_ids\": [\n    \"<string>\"\n  ]\n}"

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

{
  "scope_count": 123,
  "cohort_count": 123,
  "eligible_count": 123,
  "measured_count": 123,
  "cohorts": [
    {
      "value": "<string>",
      "label": "<string>",
      "count": 0
    }
  ],
  "cohort": "<string>",
  "metrics": [
    {
      "value": "<string>",
      "label": "<string>",
      "count": 0
    }
  ],
  "metric": "<string>",
  "direction": "<string>",
  "display": "<string>",
  "mode": "<string>",
  "points": [
    {
      "run_id": "<string>",
      "job_id": "<string>",
      "name": "<string>",
      "value": 123,
      "step": 123
    }
  ],
  "parameters": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ],
      "distinct": 123,
      "present": 123,
      "minimum": 123,
      "maximum": 123,
      "best_value": "<string>"
    }
  ],
  "fixed_parameters": 123,
  "best": {
    "run_id": "<string>",
    "job_id": "<string>",
    "name": "<string>",
    "value": 123,
    "step": 123
  },
  "minimum": 123,
  "maximum": 123,
  "median": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

授权

Authorization

string

header

必填

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

请求体

application/json

project

string

必填

metric

string

默认值:""

cohort

string

默认值:""

mode

string

默认值:final

Pattern: ^(final|best|latest)$

direction

string | null

Pattern: ^(higher|lower|neutral)$

run_ids

string[] | null

Maximum array length: 500

响应

Successful Response

scope_count

integer

必填

cohort_count

integer

必填

eligible_count

integer

必填

measured_count

integer

必填

cohorts

ProjectInsightChoice · object[]

必填

Show child attributes

cohort

string

必填

metrics

ProjectInsightChoice · object[]

必填

Show child attributes

metric

string

必填

direction

string

必填

display

string

必填

mode

string

必填

points

ProjectInsightPoint · object[]

必填

Show child attributes

parameters

ProjectInsightParameter · object[]

必填

Show child attributes

fixed_parameters

integer

必填

best

ProjectInsightPoint · object | null

Show child attributes

minimum

number | null

maximum

number | null

median

number | null

开始

接口

Insights

授权

请求体

响应