A time period is an object that represents a domain-scoped date range that can be set on goals.
TimePeriodCompact
Property | Type | Description |
---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
end_on | string | The localized end date of the time period in YYYY-MM-DD format. |
start_on | string | The localized start date of the time period in YYYY-MM-DD format. |
period | string | The cadence and index of the time period. Values can be: FY , H1 , H2 , Q1 , Q2 , Q3 , Q4 . |
display_name | string | A string representing the cadence code and the fiscal year. |
Example JSON for TimePeriodCompact
:
{
"gid": "12345",
"resource_type": "time_period",
"end_on": "2019-09-14",
"start_on": "2019-09-13",
"period": "Q1",
"display_name": "Q1 FY22"
}
TimePeriod
Property | Type | Description |
---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
end_on | string | The localized end date of the time period in YYYY-MM-DD format. |
start_on | string | The localized start date of the time period in YYYY-MM-DD format. |
period | string | The cadence and index of the time period. Values can be: FY , H1 , H2 , Q1 , Q2 , Q3 , Q4 . |
display_name | string | A string representing the cadence code and the fiscal year. |
parent | object | Full object requires scope: |
parent.gid | string | Globally unique identifier of the resource, as a string. |
parent.resource_type | string | The base type of this resource. |
parent.end_on | string | The localized end date of the time period in YYYY-MM-DD format. |
parent.start_on | string | The localized start date of the time period in YYYY-MM-DD format. |
parent.period | string | The cadence and index of the time period. Values can be: FY , H1 , H2 , Q1 , Q2 , Q3 , Q4 . |
parent.display_name | string | A string representing the cadence code and the fiscal year. |
Example JSON for TimePeriod
:
{
"gid": "12345",
"resource_type": "time_period",
"end_on": "2019-09-14",
"start_on": "2019-09-13",
"period": "Q1",
"display_name": "Q1 FY22",
"parent": {
"gid": "12345",
"resource_type": "time_period",
"end_on": "2019-09-14",
"start_on": "2019-09-13",
"period": "Q1",
"display_name": "Q1 FY22"
}
}