Usage reports

Create user report job

Initiates a job for generating a user report using the provided user parameters, and returns a job_id in response.

POST /reports/usage/v1/user

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api.browserstack.com/reports/usage/v1/user"

No parameter is required.
If startDate and endDate filters are not specified, reports are returned with usage data from the last two weeks.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "message": "Report is successfully queued.",
    "data": {
        "job_id": "aabe52c63dg624c8744ab5h9"
    }
}

success String

status
message String

Status message
data Object

Details of the job created

▶ SHOW VALUES
- job_id String
  
  Unique Identifier of the job created.

Get user report job status

This endpoint can be used to track the status of a job created to retrieve a user report. Once the job transitions to the completed state, you can then proceed to retrieve the report.

GET /reports/usage/v1/user/{job_id}/status

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.co/reports/usage/v1/user/{job_id}/status"

job_id^* String

Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "status": "enqueued",
    "message": "Request enqueued successfully"
}

success String

List of activities
status String

Current status of the job

Get user report

Retrieve the user report that has been generated.

GET /reports/usage/v1/user/{job_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/reports/usage/v1/user/{job_id}"

job_id^* String

Unique Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "message": "Success",
    "data": {
        "users": [
            {
                "name": "Steve",
                "email": "steve@example.com",
                "role": "Owner",
                "team": "Acme Inc. (Org)",
                "product_access": {
                    "live_testing": true,
                    "automate": false,
                    "app_live_testing": true,
                    "app_automate": false
                },
                "usage": {
                    "last_activity": "2023-06-30T11:33:40+00:00",
                    "last_test": "2023-06-30T11:33:40+00:00",
                    "product_data": {
                        "live_testing": {
                            "tests_run": 10,
                            "minutes_used": 180
                        },
                        "app_live_testing": {
                            "tests_run": 10,
                            "minutes_used": 120
                        },
                        "automate": {
                            "tests_run": 10,
                            "cypress_executions_run": 5,
                            "current_parallels_allocated": 5,
                            "max_parallels_used": 2,
                            "parallel_consumption_type": "org"
                        },
                        "app_automate": {
                            "tests_run": 10,
                            "current_parallels_allocated": 3,
                            "max_parallels_used": 2,
                            "parallel_consumption_type": "team"
                        }
                    }
                }
            }
        ]
    }
}

success String

Status
message String

Success/failure message description
data Object

User Report data

▶ SHOW VALUES
- users Array[Object]
  
  Array of members’ identity and usage details
  
  ▶ SHOW VALUES
  - name String
    
    Name of the member.
  - email String
    
    Email of the member.
  - role String
    
    Role of the member.
  - team String
    
    Name of the Team to which the member belongs.
  - product_access Object
    
    Product access details for the member
    
    ▶ SHOW VALUES
    - live_testing Boolean
      
      Value is set to true if product-access to Live is enabled for the member.
    - automate Boolean
      
      Value is set to true if product-access to Automate is enabled for the member.
    - app_live_testing Boolean
      
      Value is set to true if product-access to App Live is enabled for the member.
    - app_automate Boolean
      
      Value is set to true if product-access to App Automate is enabled for the member.
  - usage Object
    
    Usage details of the member
    
    ▶ SHOW VALUES
    - last_activity String
      
      Timestamp of member’s last activity on BrowserStack. This will be the latest of last login, test performed, or activity on /account section.
    - last_test String
      
      Timestamp of member’s last test on BrowserStack.
    - product_data Object
      
      Member’s usage details across different products
      
      ▶ SHOW VALUES
      - live_testing Object
        
        Product usage for Live. This will be returned only if the applied product filter is either “All-Products” or “Live”.
        
        ▶ SHOW VALUES
        
        minutes_used Integer
        
        Total minutes of product usage during the specified time period
        
        tests_run Integer
        
        Total number of test sessions run
      - app_live_testing Object
        
        Product usage for App Live. This will be returned only if the applied product filter is either “All-Products” or “App-Live”.
        
        ▶ SHOW VALUES
        
        minutes_used Integer
        
        Total minutes of product usage during the specified time period
        
        tests_run Integer
        
        Total number of test sessions run
      - automate Object
        
        Product usage for Automate. This will be returned only if the applied product filter is either “All-Products” or “Automate”.
        
        ▶ SHOW VALUES
        
        tests_run Integer
        
        Total number of test sessions run during the specified time period
        
        cypress_executions_run Integer
        
        Total number of cypress executions run
        
        current_parallels_allocated Integer
        
        Current allocation of resources i.e. number of parallels assigned to member’s team for Automate product.
        
        max_parallels_used Object
        
        Maximum number of parallels consumed by the member’ team for Automate product.
        
        parallel_consumption_type String
        
        This value will be set to “team” when a member’s parallel consumption is drawn from their team’s reserved parallels. Otherwise, it will be set to “org” indication that their parallels utilization is drawn from the organization’s shared pool.
      - app_automate Object
        
        Product usage for App Automate. This will be returned only if the applied product filter is either “All-Products” or “App-Automate”.
        
        ▶ SHOW VALUES
        
        current_parallels_allocated Integer
        
        Current allocation of resources i.e. number of parallels assigned to member’s team for Automate product.
        
        max_parallels_used Integer
        
        Maximum number of parallels consumed by the member’ team for Automate product.
        
        parallel_consumption_type String
        
        This value will be set to “team” when a team’s parallel consumption is drawn from its reserved parallels. Otherwise, this value will be set to “org” indicating that its utilization is drawn from the organization’s shared pool.

Delete user report job

Using this API, you can dequeue a user report job that was created earlier, to reduce the total number of concurrent jobs within the queue.

DELETE /reports/usage/v1/user/{job_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api.browserstack.co/reports/usage/v1/user/{job_id}/status"

job_id^* String

Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success" :true,
    "message": "Report is successfully removed from queue."
}

success String

success/failure message
message String

Report is successfully removed from queue.

Create team report job

Use this API to create a job for generating a team report. On successful completion, this API enques the job and returns a job_id in response.

POST /reports/usage/v1/team

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api.browserstack.com/reports/usage/v1/team"

No parameter is required.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "message": "Report is successfully queued.",
    "data": {
        "job_id": "aabe52c63dg624c8744ab5h9"
    }
}

success String

status
message String

Status message
data Object

Details of the job created

▶ SHOW VALUES
- job_id String
  
  Unique Identifier of the job created.

Get team report job status

Using this endpoint, you can track the status of a job created to retrieve a team report. Once the job moves to completed state, you can proceed to retrieve the corresponding team report.

GET /reports/usage/v1/team/{job_id}/status

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.co/reports/usage/v1/team/{job_id}/status"

job_id^* String

Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "status": "enqueued",
    "message": "Request enqueued successfully"
}

success String

List of activities
status String

Current status of the job

Get team report

Retrieve the user report that has been generated.

GET /reports/usage/v1/team/{job_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/reports/usage/v1/user/{job_id}"

job_id^* String

Unique Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "message": "Success",
    "data": {
        "teams": [
            {
                "name": "Acme team",
                "user_count": 10,
                "type": "org",
                "product_access": {
                    "live_testing": false,
                    "automate": true,
                    "app_live_testing": false,
                    "app_automate": true
                },
                "usage": {
                    "last_test": "2023-06-30T11:33:40+00:00",
                    "product_data": {
                        "live_testing": {
                            "minutes_used": 180
                        },
                        "app_live_testing": {
                            "minutes_used": 120
                        },
                        "automate": {
                            "current_parallels_allocated": 5,
                            "max_parallels_used": 2,
                            "parallel_consumption_type": "team"
                        },
                        "app_automate": {
                            "current_parallels_allocated": 3,
                            "max_parallels_used": 2,
                            "parallel_consumption_type": "team"
                        }
                    }
                }
            }
        ]
    }
}

success String

Status
message String

Success/failure message description
data Object

User Report data

▶ SHOW VALUES
- teams Array[Object]
  
  Array containing the usage details for each team, where the reported data represents the cumulative usage of all the team members.
  
  ▶ SHOW VALUES
  - name String
    
    Name of the Team.
  - user_count Integer
    
    Count of members in the team.
  - type String
    
    This value will be set to “org” for root of your organization’s account on Browserstack. For team’s within that account, value is set to “team”.
  - product_access Object
    
    High level product access details of members within the team.
    
    ▶ SHOW VALUES
    - live_testing Boolean
      
      Value is set to true if product-access to Live is enabled for the member.
    - automate Boolean
      
      Value is set to true if product-access to Automate is enabled for the member.
    - app_live_testing Boolean
      
      Value is set to true if product-access to App Live is enabled for the member.
    - app_automate Boolean
      
      Value is set to true if product-access to App Automate is enabled for the member.
  - usage Object
    
    Combined usage details of all members within the team.
    
    ▶ SHOW VALUES
    - last_activity String
      
      Timestamp of the team’s last activity on BrowserStack. This will be the latest of team members’ last login, test performed, or activity on /account section.
    - product_data Object
      
      Details of team’s usage across different products
      
      ▶ SHOW VALUES
      - live_testing Object
        
        Product usage details for Live. This will be returned only if the applied product filter is either “All-Products” or “Live”.
        
        ▶ SHOW VALUES
        
        minutes_used Integer
        
        Total minutes of product usage during the specified time period
      - app_live_testing Object
        
        Product usage details for App Live. This will be returned only if the applied product filter is either “All-Products” or “App-Live”.
        
        ▶ SHOW VALUES
        
        minutes_used Integer
        
        Total minutes of product usage during the specified time period
      - automate Object
        
        Product usage details for Automate. This will be returned only if the applied product filter is either “All-Products” or “Automate”.
        
        ▶ SHOW VALUES
        
        current_parallels_allocated Integer
        
        Current resource i.e. parallels allocation for the team for Automate product.
        
        max_parallels_used Object
        
        Maximum number of parallels consumed by the team for Automate product.
        
        parallel_consumption_type String
        
        This value will be set to “team” when a team’s parallel consumption is drawn from its reserved parallels. Otherwise, this value will be set to “org” indicating that its utilization is drawn from the organization’s shared pool.
      - app_automate Object
        
        Product usage details for App Automate. This will be returned only if the applied product filter is either “All-Products” or “App-Automate”.
        
        ▶ SHOW VALUES

Delete team report job

Using this API, you can dequeue a team report job that was created earlier, to reduce the total number of concurrent jobs within the queue.

DELETE /reports/usage/v1/user/{job_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api.browserstack.co/reports/usage/v1/user/{job_id}/status"

job_id^* String

Identifier of the corresponding job created.

Response attributes `200` `application/json`

Response

{
    "success": true,
    "message": "Report is successfully removed from queue."
}

success String

success/failure message
message String

Report is successfully removed from queue.

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Usage reports

Create user report job

Request parameters

Response attributes 200 application/json

success String

message String

data Object

job_id String

Get user report job status

Request parameters

job_id* String

Response attributes 200 application/json

success String

status String

Get user report

Request parameters

job_id* String

Response attributes 200 application/json

success String

message String

data Object

users Array[Object]

name String

email String

role String

team String

product_access Object

live_testing Boolean

automate Boolean

app_live_testing Boolean

app_automate Boolean

usage Object

last_activity String

last_test String

product_data Object

live_testing Object

minutes_used Integer

tests_run Integer

app_live_testing Object

minutes_used Integer

tests_run Integer

automate Object

tests_run Integer

cypress_executions_run Integer

current_parallels_allocated Integer

max_parallels_used Object

parallel_consumption_type String

app_automate Object

current_parallels_allocated Integer

max_parallels_used Integer

parallel_consumption_type String

Delete user report job

Request parameters

job_id* String

Response attributes 200 application/json

success String

message String

Create team report job

Request parameters

Response attributes 200 application/json

success String

message String

data Object

job_id String

Get team report job status

Request parameters

job_id* String

Response attributes 200 application/json

success String

status String

Get team report

Request parameters

job_id* String

Response attributes 200 application/json

success String

message String

data Object

teams Array[Object]

name String

user_count Integer

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`

job_id^* String

Response attributes `200` `application/json`