CIcint
Projects

Retrieve a project summary

This endpoint retrieves a summary overview of a single project, including its status and key performance statistics.

get/demand/accounts/{account_id}/projects/{project_id}/overview

Request

Response

Returns a summary overview of the specified project.

idstring required

The character string representing a unique project ID (ULID format).

human_readable_idstring required

The project's human-readable ID. This ID is unique within the scope of an account.

namestring

Name of the Project.

account_idinteger required

The account's unique identifier.

status'active' | 'inactive' required

The status of the project.

project_manager_idstring uuid required

A unique identifier for the user.

project_customer_reference_numberstring

Customer reference number assigned to the project.

created_atstring date-time required

Date and time when the project was created (RFC3339 UTC format, 3 fractional digits).

Example response

{
  "id": "01BTGNYV6HRNK8K8VKZASZCFP0",
  "human_readable_id": "FT354J",
  "name": "Test Project",
  "account_id": 101,
  "status": "active",
  "statistics": {
    "filling_goal": 1000,
    "current_completes": 412,
    "current_prescreens": 546,
    "incidence_rate_median": 0.05,
    "length_of_interview_median_seconds": 1,
    "conversion_rate_average": 0.05,
    "drop_off_rate_average": 0.05
  },
  "project_manager_id": "b551326b-ac9d-4d32-8823-4f025787dab9",
  "project_customer_reference_number": "RF-4567",
  "created_at": "2023-01-01T23:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.