Api question : allowable values in Workspace Max usage
search cancel

Api question : allowable values in Workspace Max usage

book

Article ID: 217694

calendar_today

Updated On:

Products

BlazeMeter

Issue/Introduction

I’m working on obtaining account usage info for my organization via the blazemeter api.  I’m using this call

 

https://a.blazemeter.com/api/v4/explorer/#!/workspaces/workspacesRetrieveReportMaxUsage

 

and I would like to better understand the allowable ranges/values for the parameters this call supports.  Could you please share allowed values for each parameter.

Environment

Release :

Component : BLAZEMETER PERFORMANCE TESTING

Resolution

  Below API call gives report of max uasage data for the given workspace.

https://a.blazemeter.com/api/v4/workspaces/{entity_ID}/reports/usage/tests/maxUsage

 

Parameters are:

entityId :  entity-ID for the workspace.

fromDate:   Unix Date value as a from Date (Ex: 1623976737 for June 18th 2021)

toDate:  Unix Date value as a to Date (Ex: 1623976737 for June 18th 2021). You can find the data value converstion using https://www.epochconverter.com/

chargeType:   This is the charge type and default is vu for VUHs

daysInterval:  Allowed values are numeric values. This explains, with-in from and to dates, how you want to show the max usage details. For ex. 1 indecates, it shows max usage data per 1 day. if we give 5, for every 5 days intrevel between from and to dates, it finds max usage data give you the details in output. Default value is 1.

groupBy:  Either none or testType. If we give groupBy value as testType, response will show by grouping based on test name.

 

    When you use below API call, it gives max usage data for last 1month with daysIntrevel as 1.

https://a.blazemeter.com/api/v4/workspaces/{{Entity-ID}}/reports/usage/tests/maxUsage