Get dimension values

get

https://mpulse.soasta.com/concerto/mpulse/api/v2/{apiKey}/dimension-values

Gets all Values for a dimension.

Path Params

apiKey

string

required

The mPulse App API Key, which can be found in the mPulse UI, under the General tab of the Configure Web App dialog.

Query Params

dimension

string

enum

Enum Dimension to get values for.

format

string

enum

Defaults to legacy

Enum Format of results. The default legacy output option is deprecated. Use json instead.

Allowed:

date

string

Date for the query. Specify the date parameter in YYYY-MM-DD format (ISO 8601). The current day is assumed if both date and date-comparator are absent.

date-comparator

string

enum

Defaults to Today

Enum Relative date for the query. If you use Between or Last, then specify the date parameter in YYYY-MM-DD format (ISO 8601). If you use Last, also specify trailing-seconds. If you use Between, also specify date-start and date-end. The default value is Today if both date and date-comparator are absent.

trailing-seconds

number

Number of seconds for date-comparator=Last.

date-start

string

Start date for date-comparator=Between. Specified in YYYY-MM-DD format (ISO 8601).

date-end

string

End date for date-comparator=Between. Specified in YYYY-MM-DD format (ISO 8601). Must be greater than date-start.

timezone

string

Defaults to UTC

Timezone for the query, UTC by default. Timezone names need to be parseable by Java. For example, US/Eastern, Europe/London, and Asia/Shanghai.

Headers

Authentication

string

required

All calls to this API require that you pass in the token you get from the Generate a token operation as an Authentication request header. See Get started for help to initially call the API.

Responses

400

Bad request.

401

Unauthorized. The security token may be invalid. Security tokens last 5 hours, if idle. See Get started for help initially running the API.

429

Too many requests. See Rate limiting for more details.

500

Internal error.

200All values for a dimension.