api:applications:usage-data

Retrieves aggregate usage data for an application, filterable by views or visits and by environment.

For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.

acli api:applications:usage-data [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <applicationUuid>

acli api:applications:usage-data da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"

acli api:applications:usage-data myapp --from="-7d" --to="-1d"

Arguments

• applicationUuid

  Required

  The entity's universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

Options

• --from

  Required

  Specifies relative or absolute time period to retrieve results from. (Default value -7d)

• --to

  Required

  Optionally specifies relative or absolute time period to retrieve results until.

• --filter

  Required

  The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: `= (%3D)` * Does not equal: `!= (!%3D)` * Greater than: `> (%3E)` * Less than: `< (%3C)` * Greater than or equal to: `>= (%3E%3D)` * Less than or equal to: `<= (%3C%3D)` * Contains substring: `=@ (%3D@)` * Does not contain substring: `!@ (!@)` Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`). Some examples: * `filter=field%3Dvalue` (`field` equals `'value'`) * `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`) * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`) * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)

• --resolution

  Required

  Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month. Limits: - 3 hour limit for “minute” resolution - 1 week limit for “hour” resolution - 6 month limit for “day” resolution - 1 year limit for "week" resolution - 3 year limit for “month” resolution

• --help | -h

  Optional

  Display help for the given command. When no command is given display help for the `list` command

  Defaults to false

• --quiet | -q

  Optional

  Do not output any message

  Defaults to false

• --verbose | -v|-vv|-vvv

  Optional

  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

  Defaults to false

• --version | -V

  Optional

  Display this application version

  Defaults to false

• --ansi

  Optional

  Force (or disable --no-ansi) ANSI output

• --no-ansi

  Optional

  Negate the "--ansi" option

  Defaults to false

• --no-interaction | -n

  Optional

  Do not ask any interactive question

  Defaults to false