REST Resources
CallsDeveloperActivityForService
Description
For a specific service, returns a summary across the report interval of activity by Developer. Sort order of the returned data is the number of successful calls for each developer, in descending order.
Resource URI
/:site_id/reports/calls/developer_activity/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| limit | false | integer | Limit on the number of items that will be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| callStatusSuccessful | integer | Count of number of successful calls |
| callStatusBlocked | integer | Count of number of blocked calls |
| callStatusOther | integer | Count of number of calls that were not successful and not blocked |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsErrorcodesForService
Description
For a specific service, returns time-based counts of errors
Resource URI
/:site_id/reports/calls/errorcodes/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| errorcode_limit | false | integer | Limit on the number of distinct errorcodes for which data should be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| errorcode | string | Name of the errorcode. Example: "403 Developer Over Limit (Proxy)" |
| errorcodeCount | integer | Count of number of calls for the errorcode |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsErrorcountByDeveloperForService
Description
For a specific service, returns error count broken out by Developer
Resource URI
/:site_id/reports/calls/errorcount_by_developer/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| limit | false | integer | Limit on the number of items that will be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| errorCount | integer | Count of number of errors |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsErrorcountByMethodForService
Description
For a specific service, returns time-based counts of errors further broken out by Method
Resource URI
/:site_id/reports/calls/errorcount_by_method/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| limit | false | integer | Limit on the number of items that will be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsGeolocationForService
Description
For a specific service, returns a summary across the report interval of originating geolocation of calls
Resource URI
/:site_id/reports/calls/geolocation/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| apiMethod | string | Name of the API method. Example: "influencer_of.json" |
| methodCount | integer | Count of number of calls for the method |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsLatencyForService
Description
For a specific service, returns time-based average of call latency breaking out Mashery Proxy and the Client API
Resource URI
/:site_id/reports/calls/latency/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| trafficManagerAvgMsPerCall | float | Average time in milliseconds taken by the Mashery Traffic Manager |
| customerAPIAvgMsPerCall | float | Average time in milliseconds taken by the Customer's API |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsLatencyByMethodForService
Description
For a specific service, returns time-based average of call latency further broken out by Method PLUS some other details TBD
Resource URI
/:site_id/reports/calls/latency_by_method/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| method_limit | false | integer | Limit on the number of distinct methods for which data should be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| apiMethod | string | Name of the API method. Example: "influencer_of.json" |
| trafficManagerAvgMsPerCall | float | Average time in milliseconds taken by the Mashery Traffic Manager |
| customerAPIAvgMsPerCall | float | Average time in milliseconds taken by the Customer's API |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsLatencyByResponsecodeForService
Description
For a specific service, returns time-based average of call latency further broken out by response code PLUS some other details
Resource URI
/:site_id/reports/calls/latency_by_responsecode/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| responseCode | string | Name of the responsecode |
| trafficManagerAvgMsPerCall | float | Average time in milliseconds taken by the Mashery Traffic Manager |
| customerAPIAvgMsPerCall | float | Average time in milliseconds taken by the Customer's API |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsMethodsForService
Description
For a specific service, returns time-based count of calls by method
Resource URI
/:site_id/reports/calls/methods/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| method_limit | false | integer | Limit on the number of distinct methods for which data should be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| apiMethod | string | Name of the API method. Example: "influencer_of.json" |
| methodCount | integer | Count of number of calls for the method |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsResponsesFromCacheForService
Description
For a specific service, returns time-based percentage of successful call responses that were from Mashery Cache
Resource URI
/:site_id/reports/calls/responses_from_cache/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsStatusForService
Description
For a specific service, returns time-based count of calls by status
Resource URI
/:site_id/reports/calls/status/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| callStatusSuccessful | integer | Count of number of successful calls |
| callStatusBlocked | integer | Count of number of blocked calls |
| callStatusOther | integer | Count of number of calls that were not successful and not blocked |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsMedianVolumeByHourForService
Description
For a specific service, across the specified interval, returns median call volume by hour for a 24-hour day.
Resource URI
/:site_id/reports/calls/median_volume_by_hour/service/:service_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsErrorcodesForServiceForDeveloper
Description
For a specific service, for a specific developer, call count by error code.
Resource URI
/:site_id/reports/calls/errorcodes/service/:service_key/developer/:service_dev_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| service_dev_key | false | string | Developer's Key for the Service (API) for which you want to get reporting data. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
| errorcode_limit | false | integer | Limit on the number of distinct errorcodes for which data should be returned. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| errorcode | string | Name of the errorcode. Example: "403 Developer Over Limit (Proxy)" |
| errorcodeCount | integer | Count of number of calls for the errorcode |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsGeolocationForServiceForDeveloper
Description
For a specific service and developer, returns a summary across the report interval of originating geolocation of calls
Resource URI
/:site_id/reports/calls/geolocation/service/:service_key/developer/:service_dev_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| service_dev_key | false | string | Developer's Key for the Service (API) for which you want to get reporting data. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| limit | false | integer | Limit on the number of items that will be returned. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| geoCountryCode | string | Two-letter Geo Country Code. Example: "JP" |
| callCount | integer | Count of number of calls |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsMethodsForServiceForDeveloper
Description
For a specific service, for a specific developer, call count by method.
Resource URI
/:site_id/reports/calls/methods/service/:service_key/developer/:service_dev_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| service_dev_key | false | string | Developer's Key for the Service (API) for which you want to get reporting data. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| apiMethod | string | Name of the API method. Example: "influencer_of.json" |
| methodCount | integer | Count of number of calls for the method |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
CallsStatusForServiceForDeveloper
Description
For a specific service, for a specific developer, call status.
Resource URI
/:site_id/reports/calls/status/service/:service_key/developer/:service_dev_key
Resource Properties
| Property | Required | Type | Description |
|---|---|---|---|
| site_id | true | string | Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.' |
| service_key | true | string | Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard. |
| service_dev_key | false | string | Developer's Key for the Service (API) for which you want to get reporting data. |
| start_date | false | date-time | Oldest date for which data should be retrieved. If not specified, the date will be seven days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| end_date | false | date-time | Most recent date for which data should be retrieved. If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. |
| format | false | enum | Desired output format. Valid types are csv and json. Default type is csv. |
Resource Response
| Property | Type | Description |
|---|---|---|
| startDate | string | Start date of the range of data for the row. Example: "2011-10-24T00:00:00Z" |
| endDate | string | End date of the range of data for the row. Example: "2011-10-31T00:00:00Z" |
| serviceKey | string | Key of the Service. |
| serviceDevKey | string | Key of the Developer for the Service. |
| callStatusSuccessful | integer | Count of number of successful calls |
| callStatusBlocked | integer | Count of number of blocked calls |
| callStatusOther | integer | Count of number of calls that were not successful and not blocked |
| auditInfo | string | Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsErrorcountByMethodForService" |
Docs Navigation
- Support Documentation Portal
- Mashery API Documentation
- Mashery 2.0 API Guide
- Examples
- API Sandbox
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Mashery 1.0 API Guide
- Mashery 2.0 API Guide
- Tips and Tricks
- Customizing Your Portal
- API Traffic Manager
