REST Resources

 

Area APIs

AreaCacheHitRate

Description

For a specific customer and date range, returns the rate of api calls served through the Mashery Cache relative to
the total call volume through the area.

Resource URI

/:site_id/reports/area/cache-hit-rate

Resource Properties

Property Required Type Description
site_id
true
string

Your designated Mashery site identifier. To learn how to find your site ID, click here.

start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z"
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z"
rate number Rate calculation of a dimensional data array.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaCacheHitRate".

AreaCountApplicationsCreated

Description

For a specific customer and date range, returns the count of applications created within the time period.

Resource URI

/:site_id/reports/area/count/applications-created

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
total number Total count of applications that are created.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaCountApplicationsCreated".

AreaCountKeysDistributed

Description

For a specific customer and date range, returns the count of keys distributed within the time period.

Resource URI

/:site_id/reports/area/count/keys-distributed

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
total number Total number of keys distributed within the time period.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaCountKeysDistributed".

AreaCountMembersRegistered

Description

For a specific customer and date range, returns the count of members registered within the time period.

Resource URI

/:site_id/reports/area/count/members-registered

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
total number Total number of members registered.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaCountMembersRegistered".

AreaDataServed

Description

For a specific customer and date range, returns the volume of data served through the area.

Resource URI

/:site_id/reports/area/data-served

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
dataServed number Data served through the Mashery Traffic Manager in units of bytes.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaDataServed".

AreaDataServedTrend

Description

For a specific customer, and date range, returns a time chart of data served in units of Gigabytes.

Resource URI

/:site_id/reports/area/data-served/trend

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
dataServed number Data served through the Mashery Traffic Manager in units of bytes.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaDataServedTrend".

AreaPlatformAvailabilityTrend

Description

For a specific customer, and date range, returns a time chart of the percetage of api calls with status codes 503 or 504.

Resource URI

/:site_id/reports/area/platform-availablity/trend

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
percent number Percent value (meaning varies with search).
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaPlatformAvailabilityTrend".

AreaPlatformLatencyPercentileNinetyFive

Description

For a specific customer and date range, returns the calculated overall 95th percentile of latency for the area.

Resource URI

/:site_id/reports/area/platformlatency/percentile-ninety-five

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
p95 number 95th Percentile value of Calls per second measurement made at area level.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaPlatformLatencyPercentileNinetyFive".

AreaPlatformStatus

Description

For a specific customer, and for the trailing 24 hour time period, returns the ratio of the the sum of api calls with status codes 503 or 504 over the total count of api calls for the specified time period.

Resource URI

/:site_id/reports/area/platform/status

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
ratio integer Ratio calculation between 2 data arrays.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaPlatformStatus".

AreaPlatformStatusTrend

Description

For a specific customer, and date range, returns a time chart of the sum of api calls with status codes 503 or 504.

Resource URI

/:site_id/reports/area/platform-status/trend

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
ratio integer Ratio calculation between 2 data arrays.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaPlatformStatusTrend".

AreaQpsRate

Description

For a specific customer and date range, returns the maximum calls per second for the area.

Resource URI

/:site_id/reports/area/qpsrate

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
rate number Rate calculation of a dimensional data array.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaQpsRate".

AreaQpsTrend

Description

For a specific customer, and date range, returns a time chart of the maximum calls per second.

Resource URI

/:site_id/reports/area/qps/trend

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
max
number
Max value of Calls per second measurement made at area level.
p99 number 99th Percentile value of Calls per second measurement made at area level.
p98 number 98th Percentile value of Calls per second measurement made at area level.
p97 number 97th Percentile value of Calls per second measurement made at area level.
p96 number 96th Percentile value of Calls per second measurement made at area level.
p95 number 95th Percentile value of Calls per second measurement made at area level.
p94 number 94th Percentile value of Calls per second measurement made at area level.
p93 number 93th Percentile value of Calls per second measurement made at area level.
p92 number 92th Percentile value of Calls per second measurement made at area level.
p91 number 91th Percentile value of Calls per second measurement made at area level.
p90 number 90th Percentile value of Calls per second measurement made at area level.
median number Median value of Calls per second measurement made at area level.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 AreaQpsTrend".

CallsCountsChangeOverTime

Description

Returns counts of calls in a current and previous time period and calculates the percentage change comparison. Returns one row with count of calls for the current and previous interval, and the ratio.

Resource URI

/:site_id/reports/calls/counts/change_over_time

Resource Properties

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.
start_date_compare true date-time Oldest date for which comparison data should be retrieved.  Must be less than (earlier) than the start_date.
end_date_compare true date-time Most recent date for which comparison data should be retrieved.  Must be greater (later) than the start_date_compare.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
startDateCompare
string
Key of the Service.
endDateCompare string Key of the Developer for the Service.
current number Current value of dimensional data array.
previous number Previous value of dimensional data array.
ratio integer Ratio calculation between 2 data arrays.
median number Median value of Calls per second measurement made at area level.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 CallsCountsChangeOverTime".

CallsQPSForArea

Description

For a specific customer and data range, returns QPS, Data Transfer, Concurrency information in 30 minute slices.

Resource URI

/:site_id/reports/calls/qps/area

Resource Properties

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date. Data available in 60 day rolling window.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date. Data available in 60 day rolling window.
format false enum Desired output format. Currently available only in csv

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
peakBytes number Maximum data transfer measured in bytes during period
medianBytes number Median bytes tranferred per call during period
p99Bytes number 99th Percentile bytes tranferred per call during period
p95Bytes number 95th Percentile bytes tranferred per call during period
p90Bytes number 90th Percentile bytes tranferred per call during period
peakCalls number Maxium QPS during period
medianCalls number Median QPS during period
p99Calls number 99th Percentile QPS during period
p95Calls number 95th Percentile QPS during period
p90Calls number 90th Percentile QPS during period
peakConnections number Maxiumum number of concurent connections during period
medianConnections number Median number of concurrent connections during period
p99Connections number 99th Percentile concurrent connections during period
p95Connections number 95th Percentile concurrent connections during period
p90Connections number 90th Percentile concurrent connections during period

KeysUsageConsistency

Description

For a specific customer, date range returns the average count of API keys with traffic per day, the total count of API keys with traffic in the time interval, and the ratio of average count and total count aka Usage Consistency.

Resource URI

/:site_id/reports/keys/usage/consistency

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
average number Average of dimensional data array.
count number Total count of API keys with traffic in the time interval.
ratio integer Ratio of average count and total count.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 KeysUsageConsistency".

PercentageCommunicationAvailability

Description

For a specific customer and date range, returns the call volume by status codes and the calculation for Communication Availability.

Resource URI

/:site_id/reports/percentage/communication/availability

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time

Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date

end_date true date-time

Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
percent number Percent value (meaning varies with search).
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 PercentageCommunicationAvailablity".

TotalCallsPackagesSummary

Description

For a specific customer and date range, returns a timechart count of all calls.

Resource URI

/:site_id/reports/total/calls/packages-summary

Resource Properties

Property Required Type Description
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date.

Resource Response

Property Type Description
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
count number Count of total calls of Package Summary.
auditInfo string Audit Information - epoch time that the data was fetched, and the name of the method used. Example: "1322847855 TotalCallsPackagesSummary".

Service APIs

 

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsDeveloperActivityForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsErrorcountByDeveloperForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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".

CallsErrorcodesForService

Description

For a specific service, returns time-based counts of errors

Resource URI

/:site_id/reports/calls/errorcodes/service/:service_key

Resource Properties

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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.
limit false integer Limit on the number of items that will be returned.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsErrorcodesForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsGeolocationForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsLatencyForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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.
limit false integer Limit on the number of items that will be returned.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsLatencyByMethodForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-12-01T00:00:00Z.
errorcode_limit false integer Limit on the number of distinct errorcodes for which data should be returned.
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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsLatencyByResponsecodeForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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.
limit false integer Limit on the number of items that will be returned.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsMethodsForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsMedianVolumeByHourForService".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsResponsesFromCacheForService".

CallsQPSForEndpoint

Description

For a specific customer and data range, returns QPS, Data Transfer, Concurrency information by Endpoint in 30 minute slices.

Resource URI

/:site_id/reports/calls/qps/endpoint

Resource Properties

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date. Data available in 60 day rolling window.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date. Data available in 60 day rolling window.
format false enum Desired output format. Currently available only in csv.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
endpointName string Name of the endpoint referenced in current row of data
serviceName string Name of the Service containing the Endpoint referenced in current row of data
peakBytes number Maximum data transfer measured in bytes during period
medianBytes number Median bytes tranferred per call during period
p99Bytes number 99th Percentile bytes tranferred per call during period
p95Bytes number 95th Percentile bytes tranferred per call during period
p90Bytes number 90th Percentile bytes tranferred per call during period
peakCalls number Maxium QPS during period
medianCalls number Median QPS during period
p99Calls number 99th Percentile QPS during period
p95Calls number 95th Percentile QPS during period
p90Calls number 90th Percentile QPS during period
peakConnections number Maxiumum number of concurent connections during period
medianConnections number Median number of concurrent connections during period
p99Connections number 99th Percentile concurrent connections during period
p95Connections number 95th Percentile concurrent connections during period
p90Connections number 90th Percentile concurrent connections during period

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsStatusForService".

Developer APIs

 

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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.
limit false integer Limit on the number of items that will be returned.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsErrorcodesForServiceForDeveloper".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsGeolocationForServiceForDeveloper".

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-12-01T00:00:00Z.
format false enum Desired output format. Valid types are csv and json. Default type is csv.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsMethodsForServiceForDeveloper".

CallsQPSForDeveloper

Description

For a specific customer and data range, returns QPS, Data Transfer, Concurrency information by Developer in 30 minute slices.

Resource URI

/:site_id/reports/calls/qps/developer

Resource Properties

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
start_date true date-time Oldest date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be less than (earlier) than the end_date. Data available in 60 day rolling window.
end_date true date-time Most recent date for which data should be retrieved.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 2015-12-01T00:00:00Z.
Note: Must be greater (later) than the start date. Data available in 60 day rolling window.
format false enum Desired output format. Currently available only in csv.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-10-31T00:00:00Z".
ServiceDevKey string Developer's Key for the Service (API) for a the current row of data
peakBytes number Maximum data transfer measured in bytes during period
medianBytes number Median bytes tranferred per call during period
p99Bytes number 99th Percentile bytes tranferred per call during period
p95Bytes number 95th Percentile bytes tranferred per call during period
p90Bytes number 90th Percentile bytes tranferred per call during period
peakCalls number Maxium QPS during period
medianCalls number Median QPS during period
p99Calls number 99th Percentile QPS during period
p95Calls number 95th Percentile QPS during period
p90Calls number 90th Percentile QPS during period
peakConnections number Maxiumum number of concurent connections during period
medianConnections number Median number of concurrent connections during period
p99Connections number 99th Percentile concurrent connections during period
p95Connections number 95th Percentile concurrent connections during period
p90Connections number 90th Percentile concurrent connections during period

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

PropertyRequiredTypeDescription
site_id true string Your designated Mashery site identifier. To learn how to find your site ID, click here.
service_key true string Mashery API ID for the Service (API) for which you want to get reporting data. To learn how to find your service key, click here.
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 2015-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 2015-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 to be returned.

Resource Response

PropertyTypeDescription
startDate string Start date of the range of data for the row. Example: "2015-10-24T00:00:00Z".
endDate string End date of the range of data for the row. Example: "2015-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 CallsStatusForServiceForDeveloper".

Docs Navigation