Analytics Portal

Analytics REST API Versioning

Current API version is: v1

The demanded version is provided in path parameter like below:

/api/v1/oauth/

/api/v1/daily/

If the version requested in the path does not exist, the API will respond with

“HTTP 404 Not Found” error code.

HTTP Status Codes

The Analytics API attemps to return appropriate HTTP status codes for every request.

Code Text Description
200 OK Success!
400 Bad Request The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized Missing or incorrect authentication credentials.
403 Forbidden The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why.
404 Not Found The URI requested is invalid or the requested API version does not exist.
410 Gone This resource is gone. Used to indicate that an API endpoint has been turned off.
422 Unprocessable Entity Unsupported combination of parameters
429 Too Many Requests Returned in when a request cannot be served due to the application’s rate limit having been exhausted for the resource. See Rate Limiting.
500 Internal Server Error Something is broken. Contact the site administrator providing the error id. The error message body contains error code to find the exception stack trace in the logs.

Error Codes

Analytics REST API will use HTTP response error codes together with API specific error messages in response body:

GET https://analytics.blackberry.com/api/daily/locale?startDate=2016-01-25&endDate=2017-03-26

400 Bad Request

{
  "errors":
  [
    {
      "message":"Time range exceeds maximum limit of 365 days",
      "code":12
    }
  ]
}

500 Internal Server Error

{
  "code":500,
  "message":"There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Code Text Description
01 Invalid JWT token The JWT token used in the request is incorrect.
02 Invalid or expired access token The access token used in the request is incorrect - invalid or expired.
03 Expired JWT token The JWT token used in the request has expired.
10 Invalid parameter Corresponds with HTTP 400 - parameter was passed with wrong format.
11 Missing header Corresponds with HTTP 400 - missing mandatory header.
12 Invalid date range Corresponds with HTTP 400 - invalid date range was provided.
22 Unsupported parameters Unsupported combination of parameters.
23 Unsupported query parameter Parameter ‘<PARAMETER_NAME>’ not supported for this endpoint.
33 Organization ID invalid Corresponds with HTTP 404 - no enterprise data found for organization ID associated with request.
88 Rate limit exceeded The request limit for this resource has been reached for the current rate limit window.
215 Bad authentication data Typically sent with responses with HTTP code 401. Authentication data provided was invalid.
216 No admin roles Typically sent with responses with HTTP code 403. Resource is not allowed to display without admin role.

API Rate limits

Rate limiting of the API is done per user access token.

Rate limits are divided into 15 minute intervals.

There is one bucket available for all GET requests: 1000 calls every 15 minutes.

HTTP response headers enable the client to understand where the client is at for a given rate limit, on the method that was just utilized.

HTTP Header Description
X-RateLimit-Limit the rate limit ceiling for that given endpoint
X-RateLimit-Remaining the number of requests left for the 15 minute window
X-Rate-Limit-Reset the remaining window before the rate limit resets, in UTC epoch miliseconds

When an application exceeds the rate limit for a given API endpoint, the API will return a HTTP 429 “Too Many Requests” response code, and error will be returned in the response body:

{ 
    "errors": 
    [ 
        { 
            "code": 88, 
            "message": "Rate limit exceeded" 
        } 
    ] 
}

REST API Authorization

API client needs to present a JWT token in the request Authorization header.

You can get JWT token using <#internalSAML or #>OAuth 2.0

GET /api/{version}/auth/oauth{?accessToken}

REST API requests must be authenticated with JWT token

If a client issues a request without the Authorization header, the API will respond with 401 Unauthorized and the body of the error response will contain an URL the client may use to obtain an OAuth token:

{
    "errors":[
        {
            "message":"Bad authentication data",
            "oAuthUrl":"https://analytics.blackberry.com/api/v1/auth/oauth",
            "code":215
        }
    ]
}

To construct a normal API request, include an Authorization header with the value of

Example request:

GET /api/daily?startDate=2017-01-01&endDate=2017-01-01

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
               eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.
               yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw

Using an incorrect or revoked bearer token to make API requests will result in:

401 Unauthorized

{
    "errors": [
        {
            "message":"Invalid JWT token",
            "code":1
        }
    ]
}

or

{
    "errors": [
        {
            "message":"Expired JWT token",
            "code":3
        }
    ]
}

<#internal

SAML example flow


Request GET /api/v1/daily

Response 401

Body:

{
    "errors": [
        {
            "message":"Bad authentication data",
            "oAuthUrl":"https://analytics.blackberry.com/api/v1/auth/oauth",
            "code":215
        }
    ]
}

Request GET _/api/v1/auth/saml?service=request&ServerPath=/dashboard&ErrorPath=/error

Response 302

Headers:

location: https://sscur-stg15.good.com:443/sso/SSOPOST/metaAlias/idp?SAMLRequest=nVPBjpswEL33K5DvgOPsdqkViNKsVo20bWnC9tBLZczQtQQ29Zgk%2FfuakHRz2I2i3tAw897Me8%2Bz%2Bb5tgi1YVEanZBJREoCWplL6V0qeiocwIfPs3QxF23R80btnvYbfPaALFohgnR9bGo19C3YDdqskPK0fU%2FLsXMfjeNs2SvflNBKoRIS7yKo20uB4QhMaD6AxjlM4P36kFrDziECCB2MlHDhTUotmKK3uU%2FJzendDK1qVIauSJLypSxomtfwQTmh1W9%2BWwEpW%2BVbMBaLawsswYg8rjU5olxJGJ3chnYaMFRPGGePTaTSh73%2BQILfGGWmaj0qPOvRWc%2BNPQK5FC8id5JvF50fOIsrLsQn5p6LIw%2FzrpiDB95OebNDTK6yRHxS8DNUdeUl21PuwsL0eQJwsIdlVBszic56RlXX8iwde3eemUfJPsGgas1taEM4L6Ww%2F%2BtIKd3mVoaKqsD60cmeFRgXakWCTD%2FDfetGoWoE9Yb7cyK5VKf638DGSUB3C4vPoYO%2BCpWk7YRUORsBeSPdfLCMJP0deNl7oNdRncFf7crFNcjlA%2B%2FIQ3Z2x1RBFkP6yYlCwM9aNnr26Tzb%2Be0uQ7GT3%2BTPO%2FgI%3D&RelayState=ServerPath%253D%252F%26ErrorPath%253D%252Ferror

After successful login

Request POST /api/v1/auth/saml/response

Body:

SAMLResponse:PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6...
RelayState:ServerPath%3D%2F&ErrorPath%3D%2Ferror

Response 302

Headers:

location: https://analytics.blackberry.com/dashboard
Set-Cookie: JWT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0. yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw

#>

oAuth example flow


Request GET /api/v1/daily

Response 401

Body:

{
    "errors": [
        {
            "message":"Bad authentication data",
            "oAuthUrl":"https://analytics.blackberry.com/api/v1/auth/oauth",
            "code":215
        }
    ]
}

Request POST https://oauth_server/sso/oauth2/access_token

Body:

Response 200

Body:

{
    "scope":"com.good.oauth2.client.general goodCurUserLevel goodOrgID goodOrgRole goodOrgType inetUserStatus mail o",
    "expires_in":599,
    "token_type":"Bearer",
    "refresh_token":"77aa8eb9-280b-4ef2-a042-1d8964967a7d",
    "access_token":"83587653-e83e-419b-9281-6467a2761480"
}

Request GET /api/v1/auth/oauth?accessToken=f9063e26-3a29-41ec-86de-1d0d68aa85e9

Response 200

Body:

{
    "JWTToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0. yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw"
}

Auth

Authentications methods

Authentication by OAuth `deprecated`

GET https://analytics.blackberry.com/api/v1/auth/oauth?accessToken=f9063e26-3a29-41ec-86de-1d0d68aa85e9
Requestsexample
Headers
Accept: application/json
Responses200401
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
    "JWTToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
                  eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.
                  RQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw"
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Invalid or expired access token",
      "code": 2
    }
  ]
}

Authentication by OAuth `deprecated`
GET/api/{version}/auth/oauth{?accessToken}

Convert oAuth access token to JWT token that will be used in portal

URI Parameters
HideShow
version
string (required) Example: v1

actual version

accessToken
string (required) Example: f9063e26-3a29-41ec-86de-1d0d68aa85e9

oAuth access token


Authentication by OAuth

POST https://analytics.blackberry.com/api/v1/auth/oauth
Requestsexample
Headers
Content-Type: application/json
Body
{
  "accessToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Responses200401
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
    "JWTToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
                  eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.
                  RQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw"
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Invalid or expired access token",
      "code": 2
    }
  ]
}

Authentication by OAuth
POST/api/{version}/auth/oauth

Convert oAuth access token to JWT token that will be used in portal

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Daily

Daily stats for portal

All stats

GET https://analytics.blackberry.com/api/v1/daily?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 27016,
    "activeCount": 27016,
    "secondsUsed": 1308635,
    "crashCount": 68,
    "newInstalls": 108,
    "uniqueActives": 1416
  },
  {
    "date": "2017-01-02",
    "launchCount": 20887,
    "activeCount": 20887,
    "secondsUsed": 994305,
    "crashCount": 71,
    "newInstalls": 114,
    "uniqueActives": 1347
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

All stats
GET/api/{version}/daily{?startDate,endDate,appId,appVersion}

return data of all applications

Supported combinations

  1. no combined parameters
  2. appId
  3. appId, appVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (optional) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter


Stats for application

GET https://analytics.blackberry.com/api/v1/daily/application?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 17,
    "activeCount": 17,
    "secondsUsed": 352,
    "crashCount": 0,
    "newInstalls": 3,
    "appId": "com.blackberry.gd.notes",
    "uniqueActives": 6
  },
  {
    "date": "2017-01-02",
    "launchCount": 11,
    "activeCount": 11,
    "secondsUsed": 486,
    "crashCount": 0,
    "newInstalls": 5,
    "appId": "com.blackberry.gd.notes.enterprise",
    "uniqueActives": 7
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application
GET/api/{version}/daily/application{?startDate,endDate,appId}

Supported combinations

  1. no combined parameters
  2. appId
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (optional) Example: com.good.gcs.g3

combined parameter


Stats for application versions

GET https://analytics.blackberry.com/api/v1/daily/application/version?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 2,
    "activeCount": 2,
    "secondsUsed": 74,
    "appVersion": "2.9.0.4181",
    "crashCount": 0,
    "newInstalls": 0,
    "uniqueActives": 0
  },
  {
    "date": "2017-01-02",
    "launchCount": 14,
    "activeCount": 14,
    "secondsUsed": 187,
    "appVersion": "2.9.0.4175",
    "crashCount": 0,
    "newInstalls": 2,
    "uniqueActives": 3
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application versions
GET/api/{version}/daily/application/version{?startDate,endDate,appId,appVersion}

Supported combinations

  1. appId
  2. appId, appVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

Stats for os

GET https://analytics.blackberry.com/api/v1/daily/os?startDate=2017-01-01&endDate=2017-01-02&osName=Android&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 10425,
    "activeCount": 10425,
    "secondsUsed": 471874,
    "crashCount": 9,
    "newInstalls": 24,
    "uniqueActives": 542,
    "osName": "android"
  },
  {
    "date": "2017-01-02",
    "launchCount": 8275,
    "activeCount": 8275,
    "secondsUsed": 372500,
    "crashCount": 21,
    "newInstalls": 25,
    "uniqueActives": 503,
    "osName": "android"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for os
GET/api/{version}/daily/os{?startDate,endDate,osName,appId,appVersion}

Supported combinations

  1. no combined parameters
  2. osName
  3. appId
  4. appId, osName
  5. appId, appVersion
  6. appId, appVersion, osName
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

osName
string (optional) Example: Android

combined parameter

appId
string (optional) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

Stats for os version

GET https://analytics.blackberry.com/api/v1/daily/os/version?startDate=2017-01-01&endDate=2017-01-02&osName=Android&osVersion=4.4.2&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 26,
    "activeCount": 26,
    "secondsUsed": 755,
    "crashCount": 0,
    "osVersion": "7.1.2",
    "newInstalls": 0,
    "uniqueActives": 2
  },
  {
    "date": "2017-01-02",
    "launchCount": 726,
    "activeCount": 726,
    "secondsUsed": 27424,
    "crashCount": 0,
    "osVersion": "7.1.2",
    "newInstalls": 2,
    "uniqueActives": 38
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for os version
GET/api/{version}/daily/os/version{?startDate,endDate,osName,osVersion,appId,appVersion}

Supported combinations

  1. osName
  2. osName, osVersion
  3. appId, osName
  4. appId, osName, osVersion
  5. appId, appVersion, osName
  6. appId, appVersion, osName, osVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

osName
string (required) Example: Android

combined parameter

osVersion
string (optional) Example: 4.4.2

combined parameter

requires:

  • osName
appId
string (optional) Example: com.good.gcs.g3

combined parameter

requires:

  • osName
appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

Stats for locale

GET https://analytics.blackberry.com/api/v1/daily/locale?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&locale=EN
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 53,
    "activeCount": 53,
    "secondsUsed": 1455,
    "crashCount": 0,
    "newInstalls": 0,
    "uniqueActives": 3,
    "locale": "de_at"
  },
  {
    "date": "2017-01-02",
    "launchCount": 504,
    "activeCount": 504,
    "secondsUsed": 32751,
    "crashCount": 1,
    "newInstalls": 0,
    "uniqueActives": 22,
    "locale": "de_de"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for locale
GET/api/{version}/daily/locale{?startDate,endDate,appId,locale}

Supported combinations

  1. no combined parameters
  2. locale
  3. appId
  4. appId, locale
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (optional) Example: com.good.gcs.g3

combined parameter

locale
string (optional) Example: EN

combined parameter


Stats for model

GET https://analytics.blackberry.com/api/v1/daily/model?startDate=2017-01-01&endDate=2017-01-02&osName=Android&appId=com.good.gcs.g3&appVersion=1.0.0&model=SAMSUNG-SM-G930A
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 6,
    "activeCount": 6,
    "secondsUsed": 442,
    "crashCount": 0,
    "newInstalls": 0,
    "uniqueActives": 1,
    "model": "Samsung-G625"
  },
  {
    "date": "2017-01-02",
    "launchCount": 6,
    "activeCount": 6,
    "secondsUsed": 149,
    "crashCount": 0,
    "newInstalls": 2,
    "uniqueActives": 2,
    "model": "Motorola X5"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for model
GET/api/{version}/daily/model{?startDate,endDate,osName,appId,appVersion,model}

Supported combinations

  1. osName
  2. osName, model
  3. appId, appVersion
  4. appId, appVersion, model
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

osName
string (optional) Example: Android

combined parameter

excludes:

  • appId

  • appId + appVersion

  • appVersion

appId
string (optional) Example: com.good.gcs.g3

combined parameter

requires:

  • appVersion

excludes:

  • osName
appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

excludes:

  • osName
model
string (optional) Example: SAMSUNG-SM-G930A

combined parameter

requires:

  • osName

  • appId + appVersion


Stats for timezone

GET https://analytics.blackberry.com/api/v1/daily/timezone?startDate=2017-01-01&endDate=2017-01-02&osName=Android&appId=com.good.gcs.g3&timezone=America/Chicago
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 20,
    "activeCount": 20,
    "secondsUsed": 867,
    "crashCount": 0,
    "newInstalls": 0,
    "timezone": "africa/johannesburg",
    "uniqueActives": 1
  },
  {
    "date": "2017-01-02",
    "launchCount": 145,
    "activeCount": 145,
    "secondsUsed": 9913,
    "crashCount": 0,
    "newInstalls": 0,
    "timezone": "america/argentina/buenos_aires",
    "uniqueActives": 3
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for timezone
GET/api/{version}/daily/timezone{?startDate,endDate,osName,appId,timezone}

Supported combinations

  1. no combined parameters
  2. timezone
  3. osName
  4. osName, timezone
  5. osName, appId
  6. osName, appId, timezone
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

osName
string (optional) Example: Android

combined parameter

appId
string (optional) Example: com.good.gcs.g3

combined parameter

requires:

  • osName
timezone
string (optional) Example: America/Chicago

combined parameter

requires:

  • osName + osVersion

  • osName + osVersion + appId

  • osName + osVersion + appId + appVersion


Stats for application features

GET https://analytics.blackberry.com/api/v1/daily/feature?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.1&features=CALENDAR,CONTACTS
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "activeCount": 4,
    "secondsUsed": 19,
    "feature": "calendar day view",
    "usagePercentage": 0,
    "uniqueActives": 3
  },
  {
    "date": "2017-01-02",
    "activeCount": 6,
    "secondsUsed": 332,
    "feature": "calendar month view",
    "usagePercentage": 17.04,
    "uniqueActives": 3
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application features
GET/api/{version}/daily/feature{?startDate,endDate,appId,appVersion,features}

Supported combinations

  1. appId
  2. appId, appVersion
  3. appId, features
  4. appId, appVersion, features
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

combined parameter

requires:

  • appId
features
string (optional) Example: CALENDAR,CONTACTS

combined parameter, uses comma as separator for features

requires:

  • appId

Os stats for specific application feature

GET https://analytics.blackberry.com/api/v1/daily/application/feature/os?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01-01",
    "launchCount": 10425,
    "activeCount": 10425,
    "secondsUsed": 471874,
    "crashCount": 9,
    "newInstalls": 24,
    "uniqueActives": 5,
    "usagePercentage": 14.2,
    "osName": "android"
  },
  {
    "date": "2017-01-02",
    "launchCount": 8275,
    "activeCount": 8275,
    "secondsUsed": 372500,
    "crashCount": 21,
    "newInstalls": 25,
    "uniqueActives": 6,
    "usagePercentage": 16.7,
    "osName": "android"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os stats for specific application feature
GET/api/{version}/daily/application/feature/os{?startDate,endDate,appId,appVersion,feature}

Supported combinations

  1. appId, feature
  2. appId, appVersion, feature
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

requires:

  • appId
feature
string (required) Example: calendar_week_view

Os version stats for specific application feature

GET https://analytics.blackberry.com/api/v1/daily/application/feature/os/version?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view&osName=ios&osVersion=9.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-10-30",
    "activeCount": 313,
    "secondsUsed": 95500,
    "osVersion": "8",
    "usagePercentage": 10.912284,
    "uniqueActives": 25,
    "osName": "android"
  },
  {
    "date": "2017-10-30",
    "activeCount": 261,
    "secondsUsed": 134500,
    "osVersion": "7",
    "usagePercentage": 16.752111,
    "uniqueActives": 77,
    "osName": "android"
  },
  {
    "date": "2017-10-30",
    "activeCount": 27,
    "secondsUsed": 49000,
    "osVersion": "10",
    "usagePercentage": 90.41584,
    "uniqueActives": 67,
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os version stats for specific application feature
GET/api/{version}/daily/application/feature/os/version{?startDate,endDate,appId,appVersion,feature,osName,osVersion}

Supported combinations

  1. appId, feature
  2. appId, feature, osName
  3. appId, feature, osName, osVersion
  4. appId, appVersion, feature
  5. appId, appVersion, feature, osName
  6. appId, appVersion, feature, osName, osVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1
feature
string (required) Example: calendar_week_view
osName
string (optional) Example: ios
osVersion
string (optional) Example: 9.0

requires:

  • osName

Os timezone stats for specific application feature

GET https://analytics.blackberry.com/api/v1/daily/application/feature/os/tz?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-10-30",
    "activeCount": 199,
    "secondsUsed": 74500,
    "timezone": "america/aruba",
    "usagePercentage": 79.51651,
    "uniqueActives": 184,
    "osName": "android"
  },
  {
    "date": "2017-10-30",
    "activeCount": 479,
    "secondsUsed": 228000,
    "timezone": "asia/tokyo",
    "usagePercentage": 32.3811,
    "uniqueActives": 201,
    "osName": "ios"
  },
  {
    "date": "2017-10-30",
    "activeCount": 51,
    "secondsUsed": 8500,
    "timezone": "europe/amsterdam",
    "usagePercentage": 36.443882,
    "uniqueActives": 185,
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os timezone stats for specific application feature
GET/api/{version}/daily/application/feature/os/tz{?startDate,endDate,appId,appVersion,feature}

Supported combinations

  1. appId, feature
  2. appId, appVersion, feature
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

requires:

  • appId
feature
string (required) Example: calendar_week_view

Os version model stats for specific application feature

GET https://analytics.blackberry.com/api/v1/daily/application/feature/os/version/model?startDate=2017-01-01&endDate=2017-01-02&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-10-30",
    "activeCount": 428,
    "secondsUsed": 174000,
    "osVersion": "8",
    "feature": "calendar day view",
    "usagePercentage": 38.91794,
    "uniqueActives": 339,
    "model": "pixel",
    "osName": "android"
  },
  {
    "date": "2017-10-30",
    "activeCount": 202,
    "secondsUsed": 22000,
    "osVersion": "10",
    "feature": "calendar day view",
    "usagePercentage": 8.383916,
    "uniqueActives": 96,
    "model": "iphone5,1",
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os version model stats for specific application feature
GET/api/{version}/daily/application/feature/os/version/model{?startDate,endDate,appId,appVersion,feature}

Supported combinations

  1. appId, feature
  2. appId, appVersion, feature
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-02

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

requires:

  • appId
feature
string (required) Example: calendar_week_view

Monthly

Monthly stats for portal

Stats for allApps

GET https://analytics.blackberry.com/api/v1/monthly?startDate=2017-01&endDate=2017-02
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 35,
    "uniqueActives": 35
  },
  {
    "date": "2017-02",
    "newInstalls": 5,
    "uniqueActives": 15
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for allApps
GET/api/{version}/monthly{?startDate,endDate}

return data of all applications

URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date


Stats for application

GET https://analytics.blackberry.com/api/v1/monthly/application?startDate=2017-01&endDate=2017-02&appId=com.good.gcs.g3
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 20,
    "appId": "com.blackberry.gd.notes",
    "uniqueActives": 21
  },
  {
    "date": "2017-02",
    "newInstalls": 29,
    "appId": "com.blackberry.gd.notes.enterprise",
    "uniqueActives": 29
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application
GET/api/{version}/monthly/application{?startDate,endDate,appId}

Supported combinations

  1. no combined parameters
  2. appId
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

appId
string (optional) Example: com.good.gcs.g3

combined parameter


Stats for application versions

GET https://analytics.blackberry.com/api/v1/monthly/application/version?startDate=2017-01&endDate=2017-02&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "appVersion": "2.9.0.4175",
    "newInstalls": 1,
    "uniqueActives": 1
  },
  {
    "date": "2017-02",
    "appVersion": "2.7.1.3124",
    "newInstalls": 1,
    "uniqueActives": 1
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application versions
GET/api/{version}/monthly/application/version{?startDate,endDate,appId,appVersion}

Supported combinations

  1. appId
  2. appId, appVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

appId
string (required) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

Stats for os

GET https://analytics.blackberry.com/api/v1/monthly/os?startDate=2017-01&endDate=2017-02&osName=Android&appId=com.good.gcs.g3&appVersion=1.0.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 35,
    "uniqueActives": 35,
    "osName": "android"
  },
  {
    "date": "2017-02",
    "newInstalls": 5,
    "uniqueActives": 15,
    "osName": "android"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for os
GET/api/{version}/monthly/os{?startDate,endDate,osName,appId,appVersion}

Supported combinations

  1. no combined parameters
  2. osName
  3. appId
  4. appId, osName
  5. appId, appVersion
  6. appId, appVersion, osName
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

osName
string (required) Example: Android

combined parameter

requires:

  • appId

  • appId + appVersion

appId
string (optional) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

Stats for os version

GET https://analytics.blackberry.com/api/v1/monthly/os/version?startDate=2017-01&endDate=2017-02&osName=Android&osVersion=4.4.2&appId=4.4.2&appVersion=4.4.2
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "osVersion": "7.1.2",
    "newInstalls": 1,
    "uniqueActives": 1
  },
  {
    "date": "2017-02",
    "osVersion": "7.1.1",
    "newInstalls": 1,
    "uniqueActives": 1
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for os version
GET/api/{version}/monthly/os/version{?startDate,endDate,osName,osVersion,appId,appVersion}

Supported combinations

  1. osName
  2. osName, osVersion
  3. appId, appVersion, osName
  4. appId, appVersion, osName, osVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

osName
string (required) Example: Android

combined parameter

osVersion
string (optional) Example: 4.4.2

combined parameter

appId
string (optional) Example: 4.4.2

combined parameter

requires:

  • osName + appVersion
appVersion
string (optional) Example: 4.4.2

combined parameter

requires:

  • osName + appId

Stats for locale

GET https://analytics.blackberry.com/api/v1/monthly/locale?startDate=2017-01&endDate=2017-02&appId=com.good.gcs.g3&appVersion=4.4.2&osName=Android&locale=EN
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 22,
    "uniqueActives": 22,
    "locale": "en_au"
  },
  {
    "date": "2017-02",
    "newInstalls": 6,
    "uniqueActives": 6,
    "locale": "en_cn"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for locale
GET/api/{version}/monthly/locale{?startDate,endDate,appId,appVersion,osName,locale}

Supported combinations

  1. no combined parameters
  2. locale
  3. osName
  4. osName, locale
  5. appId
  6. appId, locale
  7. appId, appVersion
  8. appId, appVersion, locale
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

appId
string (optional) Example: com.good.gcs.g3

combined parameter

osName
string (optional) Example: Android

combined parameter

appVersion
string (optional) Example: 4.4.2

combined parameter

locale
string (optional) Example: EN

combined parameter


Stats for model

GET https://analytics.blackberry.com/api/v1/monthly/model?startDate=2017-01&endDate=2017-02&osName=Android&appId=com.good.gcs.g3&appVersion=1.0.0&model=SAMSUNG-SM-G930A
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 31,
    "uniqueActives": 31,
    "model": "motorola d3"
  },
  {
    "date": "2017-02",
    "newInstalls": 25,
    "uniqueActives": 25,
    "model": "htc m8x"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for model
GET/api/{version}/monthly/model{?startDate,endDate,osName,appId,appVersion,model}

Supported combinations

  1. no combined parameters
  2. model
  3. osName
  4. osName, model
  5. appId
  6. appId, model
  7. appId, appVersion
  8. appId, appVersion, model
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

osName
string (optional) Example: Android

combined parameter

excludes:

  • appId

  • appVersion

  • appVersion + appId

appId
string (optional) Example: com.good.gcs.g3

combined parameter

excludes:

  • osName
appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

excludes:

  • osName
model
string (optional) Example: SAMSUNG-SM-G930A

combined parameter

requires:

  • osName

  • appId

  • appId + appVersion


Stats for timezone

GET https://analytics.blackberry.com/api/v1/monthly/timezone?startDate=2017-01&endDate=2017-02&osName=Android&appId=com.good.gcs.g3&appVersion=1.0.0&timezone=America/Chicago
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-01",
    "newInstalls": 24,
    "timezone": "america/chicago",
    "uniqueActives": 24
  },
  {
    "date": "2017-02",
    "newInstalls": 2,
    "timezone": "america/los_angeles",
    "uniqueActives": 2
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for timezone
GET/api/{version}/monthly/timezone{?startDate,endDate,osName,appId,appVersion,timezone}

Supported combinations

  1. no combined parameters
  2. timezone
  3. appId
  4. appId, timezone
  5. appId, appVersion
  6. appId, appVersion, timezone
  7. osName
  8. osName, timezone
  9. osName, appId, appVersion
  10. osName, appId, appVersion, timezone
  11. appId, osName
  12. appId, osName, timezone
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-02

End Date

osName
string (optional) Example: Android

combined parameter

appId
string (optional) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.0

combined parameter

requires:

  • appId

  • osName + appId

excludes:

  • osName
timezone
string (optional) Example: America/Chicago

combined parameter

requires:

  • appId

  • appId + appVersion

  • osName

  • osName + appId

  • osName + appId + appVersion


Stats for application features

GET https://analytics.blackberry.com/api/v1/monthly/feature?startDate=2017-08&endDate=2017-10&appId=com.good.gcs.g3&appVersion=1.0.1&features=CALENDAR,CONTACTS
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-08",
    "feature": "calendar day view",
    "newUsers": 383,
    "uniqueActives": 83
  },
  {
    "date": "2017-09",
    "feature": "calendar day view",
    "newUsers": 190,
    "uniqueActives": 277
  },
  {
    "date": "2017-10",
    "feature": "calendar day view",
    "newUsers": 119,
    "uniqueActives": 154
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Stats for application features
GET/api/{version}/monthly/feature{?startDate,endDate,appId,appVersion,features}

Supported combinations

  1. appId
  2. appId, appVersion
  3. appId, features
  4. appId, appVersion, features
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-08

Start Date

endDate
string (required) Example: 2017-10

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

combined parameter

requires:

  • appId
features
string (optional) Example: CALENDAR,CONTACTS

combined parameter, uses comma as separator for features

requires:

  • appId

Os stats for specific application feature

GET https://analytics.blackberry.com/api/v1/monthly/application/feature/os?startDate=2017-01&endDate=2017-01&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-09",
    "newUsers": 374,
    "uniqueActives": 25,
    "osName": "android"
  },
  {
    "date": "2017-09",
    "newUsers": 499,
    "uniqueActives": 119,
    "osName": "ios"
  },
  {
    "date": "2017-10",
    "newUsers": 166,
    "uniqueActives": 122,
    "osName": "android"
  },
  {
    "date": "2017-10",
    "newUsers": 47,
    "uniqueActives": 486,
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os stats for specific application feature
GET/api/{version}/monthly/application/feature/os{?startDate,endDate,appId,appVersion,feature}

Supported combinations

  1. appId, feature
  2. appId, appVersion, feature
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-01

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

requires:

  • appId
feature
string (required) Example: calendar_week_view

Os version stats for specific application feature

GET https://analytics.blackberry.com/api/v1/monthly/application/feature/os/version?startDate=2017-01&endDate=2017-01&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view&osName=ios&osVersion=9.0
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-10",
    "osVersion": "8",
    "newUsers": 143,
    "uniqueActives": 329,
    "osName": "android"
  },
  {
    "date": "2017-10",
    "osVersion": "7",
    "newUsers": 452,
    "uniqueActives": 466,
    "osName": "android"
  },
  {
    "date": "2017-10",
    "osVersion": "10",
    "newUsers": 246,
    "uniqueActives": 221,
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os version stats for specific application feature
GET/api/{version}/monthly/application/feature/os/version{?startDate,endDate,appId,appVersion,feature,osName,osVersion}

Supported combinations

  1. appId, feature
  2. appId, feature, osName
  3. appId, feature, osName, osVersion
  4. appId, appVersion, feature
  5. appId, appVersion, feature, osName
  6. appId, appVersion, feature, osName, osVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-01

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1
feature
string (required) Example: calendar_week_view
osName
string (optional) Example: ios
osVersion
string (optional) Example: 9.0

requires:

  • osName

Os timezone stats for specific application feature

GET https://analytics.blackberry.com/api/v1/monthly/application/feature/os/tz?startDate=2017-01&endDate=2017-01&appId=com.good.gcs.g3&appVersion=1.0.1&feature=calendar_week_view
Requestsexample 1
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "date": "2017-10",
    "newUsers": 263,
    "timezone": "america/aruba",
    "uniqueActives": 270,
    "osName": "android"
  },
  {
    "date": "2017-10",
    "newUsers": 322,
    "timezone": "asia/tokyo",
    "uniqueActives": 371,
    "osName": "ios"
  },
  {
    "date": "2017-10",
    "newUsers": 414,
    "timezone": "europe/amsterdam",
    "uniqueActives": 31,
    "osName": "ios"
  }
]
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Os timezone stats for specific application feature
GET/api/{version}/monthly/application/feature/os/tz{?startDate,endDate,appId,appVersion,feature}

Supported combinations

  1. appId, feature
  2. appId, appVersion, feature
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01

Start Date

endDate
string (required) Example: 2017-01

End Date

appId
string (required) Example: com.good.gcs.g3
appVersion
string (optional) Example: 1.0.1

requires:

  • appId
feature
string (required) Example: calendar_week_view

Metadata

Metadata for portal

List of All applications

GET https://analytics.blackberry.com/api/v1/applications
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "appId": "com.good.gcs.g3",
    "name": "Good Work",
    "versions": [
      {
        "name": "2.0.1"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "appId": {
        "type": "string",
        "description": "application id"
      },
      "name": {
        "type": "string",
        "description": "application name"
      },
      "versions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "version name"
            }
          },
          "required": [
            "name"
          ]
        }
      }
    },
    "required": [
      "appId",
      "name"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

List of All applications
GET/api/{version}/applications

return all applications

URI Parameters
HideShow
version
string (required) Example: v1

actual version


List of All Os

GET https://analytics.blackberry.com/api/v1/os
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "osName": "Android",
  "versions": [
    {
      "name": "2.0.1"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "osName": {
      "type": "string",
      "description": "os name"
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "version name"
          }
        },
        "required": [
          "name"
        ]
      }
    }
  },
  "required": [
    "osName",
    "versions"
  ],
  "additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

List of All Os
GET/api/{version}/os

return all os

URI Parameters
HideShow
version
string (required) Example: v1

actual version


List of All Timezone

GET https://analytics.blackberry.com/api/v1/timezone
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "name": "America/Anchorage"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "timezone name"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

List of All Timezone
GET/api/{version}/timezone

return all timezone

URI Parameters
HideShow
version
string (required) Example: v1

actual version


User Profile

GET https://analytics.blackberry.com/api/v1/profile
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "orgId": 222964041,
  "company": "Fake Company",
  "givenName": "John",
  "country": "US",
  "sn": "Fakeuser",
  "email": "fakeuser@fakecompany.com",
  "userCorrelation": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orgId": {
      "type": "number"
    },
    "company": {
      "type": "string"
    },
    "givenName": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "sn": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "userCorrelation": {
      "type": "boolean"
    }
  },
  "required": [
    "orgId",
    "company",
    "givenName",
    "country",
    "sn",
    "email",
    "userCorrelation"
  ],
  "additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

User Profile
GET/api/{version}/profile

return user profile

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Meta info statistics

GET https://analytics.blackberry.com/api/v1/metainfo/statistics
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/analytics.v1.0+x-zip-compressed
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "id": 0,
    "description": "The stats for all apps combined for the enterprise"
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "description": "id of table to export"
      },
      "description": {
        "type": "string",
        "description": "description of table to export"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Meta info statistics
GET/api/{version}/metainfo/statistics

List of all statistics that can be exported

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Export statistics

POST https://analytics.blackberry.com/api/v1/export/statistics
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Body
{
  "ids": [
    1
  ],
  "format": "CSV"
}
Schema
{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "id table to export. look at Meta info statistics"
    },
    "format": {
      "enum": [
        "CSV",
        "JSON"
      ],
      "description": "format of exported params"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200400401422429500
Headers
Content-Type: application/analytics.v1.0+x-zip-compressed
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Export statistics
POST/api/{version}/export/statistics

Export statistics as text files. You pass id field from Meta info statistics

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Application features ranking

GET https://analytics.blackberry.com/api/v1/feature/ranking?startDate=2017-01-01&endDate=2017-01-03&appId=com.good.gcs.g3&appVersion=1.0.1
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200400401422429500
Headers
Content-Type: application/analytics.v1.0+x-zip-compressed
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
[
  {
    "name": "CALENDAR",
    "rank": 1
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "rank": {
        "type": "number"
      }
    },
    "required": [
      "name",
      "rank"
    ]
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Application features ranking
GET/api/{version}/feature/ranking{?startDate,endDate,appId,appVersion}

Returns list with features and rank for selected application and data range

Supported combinations

  1. appId
  2. appId, appVersion
URI Parameters
HideShow
version
string (required) Example: v1

actual version

startDate
string (required) Example: 2017-01-01

Start Date

endDate
string (required) Example: 2017-01-03

End Date

appId
string (required) Example: com.good.gcs.g3

combined parameter

appVersion
string (optional) Example: 1.0.1

combined parameter


Settings

Organization Settings

GET https://analytics.blackberry.com/api/v1/settings
Requestsexample
Headers
Accept: application/json
Authorization: Bearer {JWT_TOKEN}
Responses200
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Body
{
  "userCorrelation": true,
  "parameter1": "value1",
  "foo": 1234
}

Organization Settings
GET/api/{version}/settings

returns all organization settings

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Setting update

POST https://analytics.blackberry.com/api/v1/settings/setting
Requestsexample
Headers
Content-Type: application/json
Body
{
  "name": "userCorrelation",
  "value": true
}
Responses200400401422429500
Headers
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 50
X-Rate-Limit-Reset: 1487857632
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Invalid date range: 2017-01-25 - 2027-01-26",
      "code": 12
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Bad authentication data. You can login using oauth2 service at <authorization_server_url> ",
      "code": 215
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "message": "Unsupported combination of parameters",
      "code": 23
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-Rate-Limit-Reset: 1487857632
Body
{
  "errors": [
    {
      "message": "Rate limit exceeded",
      "code": 88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "message for error"
          },
          "code": {
            "type": "number",
            "description": "error number code"
          }
        },
        "required": [
          "message",
          "code"
        ]
      }
    }
  }
}
Headers
Content-Type: application/json
Body
{
  "code": 500,
  "message": "There was an error processing your request. It has been logged (ID eabbf599e5b63e9e)."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "message for error"
    },
    "code": {
      "type": "number",
      "description": "error number code"
    }
  }
}

Setting update
POST/api/{version}/settings/setting

updates particular setting for given name and value

URI Parameters
HideShow
version
string (required) Example: v1

actual version


Generated on 12 Mar 2018