API response changes while using Custom Time Period in Reports

API response changes while using Custom Time Period in Reports

If you've chosen a custom time period for generating a Summary report, Availability Summary report, or Performance report, and the resultant reporting range is equivalent to that of a system-provided time range, then the final API JSON response data will look similar to that of the system-provided time range.

For example, let's say you've specified a custom date range from 1st Dec, 2018 to 10th Dec, 2018 in your Performance report. Site24x7's reporting engine will automatically equate this period with the system-provided time period "This Month".

(Before the update) This is how the info node in the JSON response looked for Custom Period
  • {
      "code": 0,
      "message": "success",
      "data": {
        "info": {
          "formatted_end_time": "December 10, 2018 12:00 AM IST",
          "monitor_type": "URL",
          "resource_id": "xxxxxxxxxxxxxxxx",
          "resource_type_name": "xxxxx",
          "period_name": "Custom Period",
          "generated_time": "2018-12-10T15:18:09+0530",
          "metric_aggregation_name": "Average",
          "report_name": "Performance Report",
          "end_time": "2018-12-10T00:00:00+0530",
          "start_time": "2018-12-01T00:00:00+0530",
          "period": 50,
          "resource_name": "1232",
          "segment_type_name": "Hour of Day",
          "formatted_start_time": "December 1, 2018 12:00 AM IST",
          "formatted_generated_time": "December 10, 2018 3:18 PM IST"
        }
      }
    }
(Post the update) This is how the info node in the JSON response looks for Custom Period
  • {
    "code": 0,
    "message": "success",
    "data": {
    "info": {
    "formatted_end_time": "December 10, 2018 12:00 AM IST",
    "monitor_type": "URL",
    "resource_id": "xxxxxxxxxxxxxx",
    "resource_type_name": "xxxxxx",
    "period_name": "This Month",
    "generated_time": "2018-12-10T15:18:09+0530",
    "metric_aggregation_name": "Average",
    "report_name": "Performance Report",
    "end_time": "2018-12-10T00:00:00+0530",
    "start_time": "2018-12-01T00:00:00+0530",
    "period": 13,
    "resource_name": "1232",
    "segment_type_name": "Hour of Day",
    "formatted_start_time": "December 1, 2018 12:00 AM IST",
    "formatted_generated_time": "December 10, 2018 3:18 PM IST"
    }
    }
    }
Note: If you carefully notice the attributes in the info node, only the period name and period constant has changed.