PUT /v3/usage-batches/{id}
Report Usage
Use this endpoint to report the usages of a set of assets. The count of assets submitted in a single batch to this endpoint is limited to 1000. Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. In this case, you will need to remove the invalid asset Ids from the query request and re-submit the query.
Quickstart
You'll need an API key and an access token to use this resource.
Note: Date of use can be in any unambiguous date format.
Servers
- https://api.gettyimages.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Specifies a unique batch transaction id to identify the report. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
asset_usages[] |
Array | No |
Identifies the list of asset id, usage count and date of usage combinations to record. |
asset_usages[].usage_date |
String | No |
Identifies the date the asset was used, in ISO 8601 format (e.g., YYYY-MM-DD), time is not needed. |
asset_usages[].quantity |
Integer | No |
Specifies the number of times the asset was used. |
asset_usages[].asset_id |
String | No |
Specifies the Id of the asset that was used. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.