Skip to content

Instantly share code, notes, and snippets.

@ALRubinger
Created July 9, 2014 20:56
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ALRubinger/9842104677be3fc7628e to your computer and use it in GitHub Desktop.
Save ALRubinger/9842104677be3fc7628e to your computer and use it in GitHub Desktop.
alr@distortion ~/business/jboss/git/bu/metrics (6 *) $ osprey list rest/src/assets/raml/api.raml
GET /sites
GET /sites/{siteId}
#%RAML 0.8
---
title: Red Hat JBoss Middleware Metrics
baseUri: http://metricsrest-alrubinger.rhcloud.com/api/{version}
version: v1
/sites:
get:
description: Obtain all site IDs for which the currently logged-in user has access to site metrics
responses:
200:
body:
text/tab-separated-values:
example: |
{
Header1 Header2
Value1 Value2
}
/{siteId}:
description: Obtain metrics for a given site ID
get:
queryParameters:
begin:
description: "Start date for retrieving metrics, in date2 format specified by RFC 2616"
required: true
type: date
example: "02 Jun 1982"
end:
description: "End date for retrieving metrics, optional (if omitted will use the current date), in date2 format specified by RFC 2616"
required: false
type: date
example: "02 Jun 1982"
by:
description: "Comma-delimited list of dimension types by which reporting metrics are categorized, for instance by date or country."
required: true
type: string
example: "DATE"
metric:
description: "Comma-delimited list of metric types to be reported"
required: true
type: string
example: "NEW_USERS, PAGEVIEWS, ORGANIC_SEARCHES, SESSIONS"
responses:
200:
body:
text/tab-separated-values:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment