Filter key Result Graph Single

Description

This endpoint filters and retrieves graph data for a specific key result. The required parameters vary dynamically based on the frequency setting of the key result.

Route Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The objective ID
`key_result_id`	integer	Yes	The key result ID

Query Parameters (Dynamic Based on Frequency)

The required query parameters depend on the frequency value of the key result:

Frequency 0: Weekly

Parameter	Type	Format	Required	Example	Description
`start_week`	string	Y-W	Yes	`2024-W01`	Start week in Year-Week format (W01-W53)
`end_week`	string	Y-W	Yes	`2024-W52`	End week in Year-Week format (W01-W53)

Frequency 1: Monthly

Parameter	Type	Format	Required	Example	Description
`start_month`	string	Y-m-1	Yes	`2024-01-1`	Start month in Year-Month-1 format
`end_month`	string	Y-m-1	Yes	`2024-12-1`	End month in Year-Month-1 format

Frequency 2: Quarterly

Parameter	Type	Format	Required	Example	Description
`start_quarter`	integer	1-10	Yes	`1`	Start quarter (1-10)
`end_quarter`	integer	1-10	Yes	`4`	End quarter (1-10)

Frequency 3: Yearly

Parameter	Type	Format	Required	Example	Description
`start_year`	string	Y	Yes	`2024`	Start year (4 digits)
`end_year`	string	Y	Yes	`2025`	End year (4 digits)

Frequency 4: Daily

Parameter	Type	Format	Required	Example	Description
`start_date`	string	Y-m-d	Yes	`2024-01-01`	Start date in ISO format
`end_date`	string	Y-m-d	Yes	`2024-12-31`	End date in ISO format (must be equal to or after start_date)

Validation Rules Summary

Weekly (Frequency 0)

start_week: Required, string, must match format YYYY-W[01-53]

end_week: Required, string, must match format YYYY-W[01-53]

Monthly (Frequency 1)

start_month: Required, string, must match format YYYY-[01-12]-1

end_month: Required, string, must match format YYYY-[01-12]-1

Quarterly (Frequency 2)

start_quarter: Required, integer, min: 1, max: 10

end_quarter: Required, integer, min: 1, max: 10

Yearly (Frequency 3)

start_year: Required, string, must be 4-digit year

end_year: Required, string, must be 4-digit year

Daily (Frequency 4)

start_date: Required, string, must match format YYYY-MM-DD

end_date: Required, string, must match format YYYY-MM-DD, must be equal to or after start_date

Notes

Dynamic Validation: The API automatically determines which parameters are required based on the key result's frequency setting.

Date Ranges: For daily frequency, the end_date must be equal to or after the start_date.

Week Numbers: Week numbers follow ISO 8601 standard (W01 to W53).

Quarter Range: Quarters can range from 1 to 10 to support multi-year planning.

Authentication: All requests require a valid Bearer token in the Authorization header.

Error Messages

Field	Error	Message
`start_week`	Invalid format	The start week format must be Y-W (example: 2024-W01)
`end_week`	Invalid format	The end week format must be Y-W (example: 2024-W01)
`start_month`	Invalid format	The start month format must be Y-m-1 (example: 2024-01-1)
`end_month`	Invalid format	The end month format must be Y-m-1 (example: 2024-01-1)
`start_quarter`	Out of range	The start quarter must be between 1 and 10
`end_quarter`	Out of range	The end quarter must be between 1 and 10
`start_year`	Invalid format	The start year format must be Y (example: 2024)
`end_year`	Invalid format	The end year format must be Y (example: 2024)
`start_date`	Invalid format	The start date format must be Y-m-d (example: 2024-12-26)
`end_date`	Invalid format	The end date format must be Y-m-d (example: 2024-12-26)
`end_date`	Invalid range	The end date must be equal to or after the start date

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Body

Example

{
    "status": "success",
    "message": "Filtered OKR dashboard data retrieved successfully",
    "data": {
        "id": 6,
        "name": "Achieve NPS score of 70",
        "frequency": 0,
        "frequency_label": "Weekly",
        "format": 2,
        "format_label": "Percentage",
        "direction": 0,
        "direction_label": "Higher is Better",
        "aggregation": 0,
        "aggregation_label": "Latest",
        "status": 1,
        "average_actual_value": 0,
        "average_target_value": 80,
        "target_value": 80,
        "data": [
            0,
            0,
            0,
            0,
            0
        ],
        "labels": [
            "Week 1 Jan 2025",
            "Week 2 Jan 2025",
            "Week 3 Jan 2025",
            "Week 4 Jan 2025",
            "Week 5 Jan 2025"
        ]
    }
}

Filter key Result Graph Single

Description#

Route Parameters#

Query Parameters (Dynamic Based on Frequency)#

Frequency 0: Weekly#

Frequency 1: Monthly#

Frequency 2: Quarterly#

Frequency 3: Yearly#

Frequency 4: Daily#

Validation Rules Summary#

Weekly (Frequency 0)#

Monthly (Frequency 1)#

Quarterly (Frequency 2)#

Yearly (Frequency 3)#

Daily (Frequency 4)#

Notes#

Error Messages#

Request