Get project insights

curl --request GET \
  --url https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights \
  --header 'Accept: <accept>' \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};

fetch('https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights"

headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "start_date": "2026-07-15",
  "end_date": "2026-08-13",
  "timezone": "Etc/UTC",
  "runs": {
    "runs_volume_data": [
      {
        "date": "Aug 13, 2026",
        "passed_runs_count": 24,
        "failed_runs_count": 3,
        "average_passing_rate": 88.89,
        "average_run_duration": 182450
      }
    ],
    "overall_data": {
      "passed_runs_count": 612,
      "failed_runs_count": 88,
      "average_passing_rate": 87.43,
      "average_run_duration": 176320.5
    }
  },
  "tests": {
    "tests_volume_data": [
      {
        "date": "Aug 13, 2026",
        "passed_tests_count": 1840,
        "failed_tests_count": 26,
        "skipped_tests_count": 12,
        "flaky_tests_count": 9,
        "timed_out_tests_count": 4,
        "pass_percentage": 97.72,
        "fail_percentage": 1.38,
        "skip_percentage": 0.64,
        "flaky_percentage": 0.48,
        "timed_out_percentage": 0.21,
        "average_passing_rate": 97.72,
        "average_flakiness_rate": 0.48
      }
    ],
    "overall_data": {
      "passed_tests_count": 48210,
      "failed_tests_count": 702,
      "skipped_tests_count": 318,
      "flaky_tests_count": 241,
      "timed_out_tests_count": 96,
      "average_passing_rate": 97.71,
      "average_flakiness_rate": 0.49
    }
  }
}

GET

projects

{project_id}

insights

Get project insights

curl --request GET \
  --url https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights \
  --header 'Accept: <accept>' \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>', Accept: '<accept>'}};

fetch('https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoplaydash.com/api/external/v1/projects/{project_id}/insights"

headers = {
    "X-Api-Key": "<x-api-key>",
    "Accept": "<accept>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "start_date": "2026-07-15",
  "end_date": "2026-08-13",
  "timezone": "Etc/UTC",
  "runs": {
    "runs_volume_data": [
      {
        "date": "Aug 13, 2026",
        "passed_runs_count": 24,
        "failed_runs_count": 3,
        "average_passing_rate": 88.89,
        "average_run_duration": 182450
      }
    ],
    "overall_data": {
      "passed_runs_count": 612,
      "failed_runs_count": 88,
      "average_passing_rate": 87.43,
      "average_run_duration": 176320.5
    }
  },
  "tests": {
    "tests_volume_data": [
      {
        "date": "Aug 13, 2026",
        "passed_tests_count": 1840,
        "failed_tests_count": 26,
        "skipped_tests_count": 12,
        "flaky_tests_count": 9,
        "timed_out_tests_count": 4,
        "pass_percentage": 97.72,
        "fail_percentage": 1.38,
        "skip_percentage": 0.64,
        "flaky_percentage": 0.48,
        "timed_out_percentage": 0.21,
        "average_passing_rate": 97.72,
        "average_flakiness_rate": 0.48
      }
    ],
    "overall_data": {
      "passed_tests_count": 48210,
      "failed_tests_count": 702,
      "skipped_tests_count": 318,
      "flaky_tests_count": 241,
      "timed_out_tests_count": 96,
      "average_passing_rate": 97.71,
      "average_flakiness_rate": 0.49
    }
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

enum<string>

default:application/json

required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:

application/json

Path Parameters

project_id

string

required

Id of the project. You can get project_id by listing your projects using the List projects API.

Example:

"pdqmxlz"

Query Parameters

start_date

string<date>

Start of the range as an ISO date. Defaults to 29 days before the end date. Must fall within the most recent 3 months.

Example:

"2026-07-15"

end_date

string<date>

End of the range as an ISO date. Defaults to today. A date in the future is clamped to today.

Example:

"2026-08-13"

branch

string

Count only runs on this branch.

Example:

"main"

author

string

Count only runs by this author.

Example:

"Oliver Smith"

Response

OK - Request succeeded. The response reports the effective start_date and end_date after clamping.

start_date

string<date>

Effective start of the range after clamping, in the requested timezone.

Example:

"2026-07-15"

end_date

string<date>

Effective end of the range after clamping, in the requested timezone.

Example:

"2026-08-13"

timezone

string

IANA timezone the day buckets and dates are expressed in.

Example:

"Etc/UTC"

runs

object

Hide child attributes

runs.runs_volume_data

object[]

One entry per day in the range, oldest first.

Hide child attributes

runs.runs_volume_data.date

string

Day the counts belong to, formatted as %b %e, %Y in the requested timezone.

Example:

"Aug 13, 2026"

runs.runs_volume_data.passed_runs_count

integer

Runs that passed on this day.

Example:

24

runs.runs_volume_data.failed_runs_count

integer

Runs that failed on this day.

Example:

3

runs.runs_volume_data.average_passing_rate

number

Percentage of this day's runs that passed.

Example:

88.89

runs.runs_volume_data.average_run_duration

number

Average run duration on this day, in milliseconds.

Example:

182450

runs.overall_data

object

Hide child attributes

runs.overall_data.passed_runs_count

integer

Runs that passed across the range.

Example:

612

runs.overall_data.failed_runs_count

integer

Runs that failed across the range.

Example:

88

runs.overall_data.average_passing_rate

number

Percentage of runs in the range that passed.

Example:

87.43

runs.overall_data.average_run_duration

number

Average run duration across the range, in milliseconds.

Example:

176320.5

tests

object

Hide child attributes

tests.tests_volume_data

object[]

One entry per day in the range, oldest first.

Hide child attributes

tests.tests_volume_data.date

string

Day the counts belong to, formatted as %b %e, %Y in the requested timezone.

Example:

"Aug 13, 2026"

tests.tests_volume_data.passed_tests_count

integer

Tests that passed on this day, flaky ones included.

Example:

1840

tests.tests_volume_data.failed_tests_count

integer

Tests that failed on this day.

Example:

26

tests.tests_volume_data.skipped_tests_count

integer

Tests skipped on this day.

Example:

12

tests.tests_volume_data.flaky_tests_count

integer

Tests that passed on a retry after failing at least once on this day.

Example:

9

tests.tests_volume_data.timed_out_tests_count

integer

Tests that timed out on this day.

Example:

4

tests.tests_volume_data.pass_percentage

number

Percentage of this day's test results that passed.

Example:

97.72

tests.tests_volume_data.fail_percentage

number

Percentage of this day's test results that failed.

Example:

1.38

tests.tests_volume_data.skip_percentage

number

Percentage of this day's test results that were skipped.

Example:

0.64

tests.tests_volume_data.flaky_percentage

number

Percentage of this day's test results that were flaky.

Example:

0.48

tests.tests_volume_data.timed_out_percentage

number

Percentage of this day's test results that timed out.

Example:

0.21

tests.tests_volume_data.average_passing_rate

number

Same value as pass_percentage, under the name the runs section uses.

Example:

97.72

tests.tests_volume_data.average_flakiness_rate

number

Same value as flaky_percentage, under the name the runs section uses.

Example:

0.48

tests.overall_data

object

Hide child attributes

tests.overall_data.passed_tests_count

integer

Tests that passed across the range, flaky ones included.

Example:

48210

tests.overall_data.failed_tests_count

integer

Tests that failed across the range.

Example:

702

tests.overall_data.skipped_tests_count

integer

Tests skipped across the range.

Example:

318

tests.overall_data.flaky_tests_count

integer

Tests that passed on a retry after failing at least once.

Example:

241

tests.overall_data.timed_out_tests_count

integer

Tests that timed out across the range.

Example:

96

tests.overall_data.average_passing_rate

number

Percentage of tests in the range that passed.

Example:

97.71

tests.overall_data.average_flakiness_rate

number

Percentage of tests in the range that were flaky.

Example:

0.49

Getting started

Projects

Insights

Runs

Test entities

Result histories

Traces

Top errors

Get project insights

Headers

Path Parameters

Query Parameters

Response