limelm.pkey.activity

Gets the activity of a product version between a date range.

Arguments

api_key (Required)

Your API application key. Your api key is available on your settings page.

version_id (Required)

The id of the version for which you want to get activity. You can get the version ID by examining the URL in your browser. For instance, from the URL https://wyday.com/limelm/version/100/ you can see the version ID is 100. (Note: The Version ID is not the Version GUID).

start (Required)

The start of the date range in the form YYYY-MM-DD (e.g. 2010-06-25) or YYYY-MM-DD hh:mm:ss.

end (Optional)

The end of the date range in the form YYYY-MM-DD (e.g. 2011-06-25) or YYYY-MM-DD hh:mm:ss. If this value is not present it finds all activity up until the present time.

created (Optional)

Whether or not to get newly created product keys. Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "false".

revoked (Optional)

Whether or not to get recent revoked & unrevoked product keys. Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "false".

activation (Optional)

Whether or not to get recent activations for product keys. Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "false".

deactivation (Optional)

Whether or not to get recent deactivations for product keys. Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "false".

Example Response

The method returns the activity in the range your specified and in the detail you specified.

<pkeys>
	<pkey id="158" key="4UV4-8KDR-9HM5-QWG4-7JWI-E4QW-86TA" acts="1" acts_used="0" created="2011-09-29 22:30:11"/>
	<pkey id="153" key="FYKI-BCD4-5NBQ-8HTM-CC4B-YD6W-JATA" acts="8" acts_used="1" created="2011-05-22 17:33:34">
		<activations>
			<act ip="127.0.0.1" date="2011-09-29 18:55:20" type="windows"/>
			<act ip="127.0.0.1" date="2011-09-29 18:56:58" type="windows"/>
			<act ip="127.0.0.1" date="2011-09-29 19:49:31" type="windows"/>
			<act ip="127.0.0.1" date="2011-09-29 19:51:05" type="windows"/>
			<act ip="127.0.0.1" date="2011-09-29 20:18:08" type="windows"/>
			<deact ip="127.0.0.1" date="2011-09-29 18:55:17" type="windows"/>
			<deact ip="127.0.0.1" date="2011-09-29 18:56:56" type="windows"/>
			<deact ip="127.0.0.1" date="2011-09-29 19:49:29" type="windows"/>
			<deact ip="127.0.0.1" date="2011-09-29 19:50:48" type="windows"/>
			<deact ip="127.0.0.1" date="2011-09-29 20:18:05" type="windows"/>
		</activations>
	</pkey>
	<pkey id="1" key="4QUM-WRPC-76S5-HYTW-TGCB-SAQU-HETA" acts="3" acts_used="2" created="2009-12-29 11:08:34" revoked_changed="2011-09-28 09:49:11"/>
</pkeys>

Error Codes

100: Invalid API Key

The API key passed was not valid or has expired.

101: Method "xxx" not found

The requested method was not found.

164: An API key must be used by X devices. Configurable in your settings.

You can only use an API key from X devices. You can set the exact number on your settings page. If you need to use the web API from multiple servers then create another user. You can also temporarily reset this message by logging into the account for which the API key is created and resetting the last used IP address on your settings page.

108: The version id is missing.

The version id was not specified.

109: The version doesnʼt exist or you donʼt have access to it.

Check to make sure you have access to the version id youʼve passed in.

118: Your account is in dormant mode. Re-enable your account.

You cannot get account activity when your account is in dormant mode. Re-enable your account and you will no longer get this error.

129: You must select one type of activity (e.g. "created=true").

You must set at least one of the activity parameters (created, revoked, activation, deactivation).

130: You must specify a start date.

Set the date parameter.

142: Service currently unavailable

The requested service is temporarily unavailable.