Skip to main content

API Change Log - Analytics

🧩 Service: Analytics​

🔧 Operation: createScheduler​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.bcc.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: ENUM_ADDED
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.attachment_type.enum
  • New Schema:
[
"csv",
"excel"
]

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates_ids.items.type
  • New Schema:
"number"

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.type

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.properties

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createScheduler.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: executeScheduler​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.executeScheduler.methodTypePlaceHolder.responses.200.content.application/json

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.executeScheduler.methodTypePlaceHolder.responses.200.content.text/html
  • New Schema:
{
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "Scheduler executed successfully"
}
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.executeScheduler.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getTemplateDetailsByFilters​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> Headers --> ReportConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.headers.items.properties.config.properties.selected_columns
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SelectedColumns"
},
"description": "An array of selected columns for the report."
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.id

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.name

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.seq_num

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.category

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.last_viewed

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.user_name

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.config

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.type

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.is_default

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.action

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails --> StringItem
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.name.properties.value.nullable
  • New Schema:
true

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.subject

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.created_at

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.status

🔹 Change 17​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.to

🔹 Change 18​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.execution_details

🔹 Change 19​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.frequency

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.seq_num
  • New Schema:
{
"$ref": "#/components/schemas/IntegerItem"
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.last_viewed
  • New Schema:
{
"$ref": "#/components/schemas/StringItem"
}

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.user_name
  • New Schema:
{
"$ref": "#/components/schemas/StringItem"
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.config
  • New Schema:
{
"$ref": "#/components/schemas/ReportItemConfig"
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.type
  • New Schema:
{
"$ref": "#/components/schemas/StringItem"
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.is_default
  • New Schema:
{
"$ref": "#/components/schemas/BooleanItem"
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.action
  • New Schema:
{
"$ref": "#/components/schemas/ActionIcon"
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateDetailsByFilters.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchSidebarDropdownValues​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSidebarDropdownValues.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getGenericDashboardTableRespModel​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericDashboardTableRespModel.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getGenericReportTableRespModel​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGenericReportTableRespModel.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getReportFilterValues​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportFilterValues.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getSchedulerFilterValues​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getSchedulerFilterValues.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getLayoutByName​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getLayoutByName.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: saveLayoutByName​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.saveLayoutByName.methodTypePlaceHolder.responses.200.content.application/json.schema.type
  • New Schema:
"object"

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: ITEMS_REMOVED
  • Path: paths.saveLayoutByName.methodTypePlaceHolder.responses.200.content.application/json.schema.items

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveLayoutByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties
  • New Schema:
{
"message": {
"type": "string"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveLayoutByName.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getLayoutPermissions​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: Permission
  • Schema Action: ENUM_ADDED
  • Path: paths.getLayoutPermissions.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.response.items.enum
  • New Schema:
[
"orders",
"inventory",
"users",
"logistics",
"finance"
]

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getLayoutPermissions.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: getSalesDumpFilters​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getSalesDumpFilters.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: getSchedulerHistory​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getSchedulerHistory.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: getSchedulerDetails​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> Headers --> ReportConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.headers.items.properties.config.properties.selected_columns
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SelectedColumns"
},
"description": "An array of selected columns for the report."
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.id

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.name

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.seq_num

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.category

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.last_viewed

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.user_name

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.config

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.type

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.is_default

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.action

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails --> StringItem
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.name.properties.value.nullable
  • New Schema:
true

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails --> StringItem
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.subject.properties.value.nullable
  • New Schema:
true

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ReportsDetailsRespModel --> ReportItem --> ReportItemDetails --> StringItem
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.created_at.properties.value.nullable
  • New Schema:
true

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem --> ReportItemValue --> ExecutionDetails
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.execution_details.properties.last_run_at

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItem --> ReportItemValue --> ExecutionDetails
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.execution_details.properties.next_run_at

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: SchedulerDetailsRespModel --> ReportItemValue --> ReportItemValueDetails --> ReportExecution
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.records.items.properties.values.properties.execution_details.properties.value
  • New Schema:
{
"$ref": "#/components/schemas/ExecutionDetails"
}

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getSchedulerDetails.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: getDashboardStatByName​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: StatFiltersResult --> StatFiltersItems
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.past_value
  • New Schema:
{
"type": "number",
"description": "The past value of the filter item."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDashboardStatByName.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: downloadReportTableData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.parameters.4
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.responses.200.content.application/json

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.responses.200.content.text/html
  • New Schema:
{
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "order_61_reportreturn_amount_1697599414002"
}
}
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableData.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: downloadReportTableDataSync​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.responses.200.content.application/json

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.responses.200.content.text/html
  • New Schema:
{
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "order_61_reportreturn_amount_1697599414002"
}
}
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.downloadReportTableDataSync.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getStatResponseV1​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.change_in_value
  • New Schema:
{
"type": "number"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getStatResponseV1.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getReportData​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getReportData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getReportData.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: createTemplate​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.createTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.createTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createTemplate.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: getTemplateLayoutById​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getTemplateLayoutById.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: fetchSchedulerById​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateResponseModel --> ExecutionDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.execution_details.properties.last_run_at.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.config.properties
  • New Schema:
{
"day_or_date": {
"oneOf": [
{
"type": "number"
},
{
"type": "array",
"items": {
"type": "number"
}
}
],
"description": "The days or dates for scheduling."
},
"frequency": {
"type": "string",
"description": "The frequency of the schedule (e.g., daily, weekly)."
},
"time": {
"type": "string",
"description": "The time for the schedule."
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.bcc.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: ENUM_ADDED
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.attachment_type.enum
  • New Schema:
[
"csv",
"excel"
]

🔹 Change 5​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.report_templates_ids.items.type
  • New Schema:
"number"

🔹 Change 6​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.report_templates.items.properties.config.properties.filters.type

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.report_templates.items.properties.config.properties.filters.properties

🔹 Change 8​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheduler_details.properties.email_detail.properties.report_templates.items.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSchedulerById.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: updateScheduler​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.bcc.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: ENUM_ADDED
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.attachment_type.enum
  • New Schema:
[
"csv",
"excel"
]

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates_ids.items.type
  • New Schema:
"number"

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.type

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.properties

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateScheduler.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email_details.properties.report_templates.items.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateScheduler.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: deleteScheduler​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteScheduler.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: updateTemplateById​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.updateTemplateById.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateTemplateById.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateTemplateById.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateTemplateById.methodTypePlaceHolder.responses.200.content.application/json

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateTemplateById.methodTypePlaceHolder.responses.200.content.text/html
  • New Schema:
{
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"examples": {
"success": {
"value": {
"message": "Template updated successfully"
}
}
}
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateTemplateById.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: deleteTemplateByID​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteTemplateByID.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: duplicateTemplate​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.duplicateTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.duplicateTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.duplicateTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.duplicateTemplate.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: validateTemplateName​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.validateTemplateName.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: fetchLayoutByTemplateName​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.layout.properties.layout_config.properties.global_filters.items.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ScheduleRequestBody --> EmailDetails --> ReportTemplate --> Config --> Filters
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.type

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.properties

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.config.properties.filters.oneOf
  • New Schema:
[
{
"$ref": "#/components/schemas/Filters"
},
{
"nullable": true
}
]

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLayoutByTemplateName.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: fetchSliderValues​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchSliderValues.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchBarGraphData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"$ref": "#/components/parameters/isComparisonGraph"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.parameters.4
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties
  • New Schema:
{
"x_axis": {
"type": "array",
"items": {
"type": "number"
}
},
"y_axis": {
"type": "array",
"items": {
"type": "object",
"properties": {
"max_value": {
"type": "number"
},
"data": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"tooltip_text": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"trend_mapping": {
"type": "array",
"items": {
"type": "number"
}
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchBarGraphData.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchLineGraphData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineGraphData.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchLineDataComparisionGraph​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.y_axis.items.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"type": "integer"
}
}
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.stat_info.items.properties.past_value
  • New Schema:
{
"type": "number"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchLineDataComparisionGraph.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchProgressBarGraphData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.end_date.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.start_date.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_start_date.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.filters.properties.global_filters.properties.compare_end_date.format
  • New Schema:
"date-time"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchProgressBarGraphData.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchStatData​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.fetchStatData

🔧 Operation: cancelExportJob​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelExportJob.methodTypePlaceHolder.parameters.4
  • New Schema:
{
"$ref": "#/components/parameters/source"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelExportJob.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: checkJobStatusByNameV2​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.checkJobStatusByNameV2.methodTypePlaceHolder.responses.200.content.application/json.schema.properties
  • New Schema:
{
"start_date": {
"type": "string",
"format": "date-time",
"description": "The start date and time of the job."
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "The end date and time of the job.",
"nullable": true
},
"status": {
"type": "string",
"description": "The current status of the job."
},
"message": {
"type": "string",
"description": "Message providing additional details about the job status."
},
"file_metadata": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true,
"description": "Metadata about files associated with the job, if any."
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.checkJobStatusByNameV2.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/read"
]
}
]

🔧 Operation: executeJobForProvidedParametersV2​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: TemplateDetailsRequestBody --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.executeJobForProvidedParametersV2.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.executeJobForProvidedParametersV2.methodTypePlaceHolder.responses.200.content.application/json.schema.properties
  • New Schema:
{
"rows": {
"type": "array",
"additionalProperties": true,
"items": {
"type": "object"
},
"description": "Array of rows resulting from the job execution."
},
"page": {
"$ref": "#/components/schemas/Page"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.executeJobForProvidedParametersV2.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: startDownloadForQueryV2​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.startDownloadForQueryV2.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/analytics/write"
]
}
]

🔧 Operation: fetchPieChartGraphData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.fetchPieChartGraphData
  • New Schema:
{
"methodTypePlaceHolder": {
"x-accessScopes": [
"company/analytics/dashboard"
],
"tags": [
"Platform template"
],
"operationId": "fetchPieChartGraphData",
"summary": "Get pie chart graph data",
"description": "Fetch pie chart graph data fo provided filters",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/categoryForLogistics"
},
{
"$ref": "#/components/parameters/pieGraphName"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardFilterPayload"
},
"examples": {
"success": {
"value": {
"filters": {
"global_filters": {
"end_date": "2023-10-19T18:29:59.000Z",
"start_date": "2023-09-30T18:30:00.000Z",
"shortcut": "quarterToDate",
"sales_channel": [
"{\"id\":\"64b514b1bb259182ca3d00e6\",\"is_marketplace\":true}"
],
"time_frame_clause": "daily",
"compare_start_date": "2023-09-11T18:30:00.000Z",
"compare_end_date": "2023-09-30T18:29:59.000Z"
},
"sidebar_filters": [
{
"id": "store_code",
"value": [
{
"text": "PIE_STORE",
"value": "PIE_STORE"
}
],
"data_type": "string"
}
],
"graph_filter": [],
"screen_size": 550.5
},
"screen_size": "S"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Pie chart graph data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PieChartResponseModel"
},
"examples": {
"success": {
"value": {
"x_axis": [
"Delhivery Air"
],
"y_axis": [
{
"data": [
"1353690"
]
},
{
"background_color": [
"#85B82B"
]
}
]
}
}
}
}
}
}
},
"x-groups": [
"Analytics and Reports"
],
"security": [
{
"oauth2": [
"company/analytics/write"
]
}
],
"path": "/service/platform/insights/v2.0/company/{company_id}/dashboard/{category}/pie/{graph_name}",
"methodType": "post"
}
}

🔧 Operation: fetchMapResponseData​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.fetchMapResponseData
  • New Schema:
{
"methodTypePlaceHolder": {
"x-accessScopes": [
"company/analytics/dashboard"
],
"tags": [
"Platform template"
],
"operationId": "fetchMapResponseData",
"summary": "Get map response model",
"description": "Fetch map response model for provided filters",
"parameters": [
{
"$ref": "#/components/parameters/companyId"
},
{
"$ref": "#/components/parameters/categoryForLogistics"
},
{
"$ref": "#/components/parameters/mapGraphName"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardFilterPayload"
},
"examples": {
"success": {
"value": {
"filters": {
"global_filters": {
"end_date": "2023-10-19T18:29:59.000Z",
"start_date": "2023-09-30T18:30:00.000Z",
"shortcut": "quarterToDate",
"sales_channel": [
"{\"id\":\"64b514b1bb259182ca3d00e6\",\"is_marketplace\":true}"
],
"time_frame_clause": "daily",
"compare_start_date": "2023-09-11T18:30:00.000Z",
"compare_end_date": "2023-09-30T18:29:59.000Z"
},
"sidebar_filters": [
{
"id": "store_code",
"value": [
{
"text": "MAP_STORE",
"value": "MAP_STORE"
}
],
"data_type": "string"
}
],
"graph_filter": [],
"screen_size": 550.5
},
"screen_size": "S"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Pie chart graph data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MapResponseModel"
},
"examples": {
"success": {
"value": {
"x_axis": [
"Delhi"
],
"y_axis": [
{
"data": [
"1353690"
]
}
]
}
}
}
}
}
}
},
"x-groups": [
"Analytics and Reports"
],
"security": [
{
"oauth2": [
"company/analytics/write"
]
}
],
"path": "/service/platform/insights/v2.0/company/{company_id}/dashboard/{category}/geo_map/{graph_name}",
"methodType": "post"
}
}

Was this section helpful?