Hit

GET /v1/entities/hit/{entity_id}

Retrieves a specific hit.

Request Parameters

Location Parameter Type Required/ Optional Description
path entity_id number optional The string id of the hit being searched for

Example Request

GET /v1/entities/hit/cymbal_crash HTTP/1.1
Host: api.ampermusic.com
Content-Type: application/vnd.api+json
Authorization: Basic abcxyz

Response Data

Data Item Type Description
data object
data.type string The type of data (entity_hit in this case)
data.id string The string ID of the hit
data.attributes object
data.attributes.name string The string name of the hit
data.attributes.preview array
data.attributes.preview[].url string The string url of the hit’s preview file
data.attributes.preview[].content_type string enum The content type of the preview. Of the following values:
audio/mp3
audio/ogg
data.links object
data.links.self string The URL of the hit
links object
links.self string The URL of this hit

Example Response

Header

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

Body

{
	"data": {
		"attributes": {
			"name": "Cymbal Crash",
			"preview": [
				{
					"content_type": "audio/mp3",
					"url": "<some_url>"
				},
				{
					"content_type": "audio/ogg",
					"url": "<some_url>"
				}
			]
		},
		"id": "cymbal_crash",
		"links": {
			"self": "https://api.ampermusic.com/v1/entities/hit/cymbal_crash"
		},
		"type": "entity_hit"
	},
	"links": {
		"self": "https://api.ampermusic.com/v1/entities/hit/cymbal_crash"
	}
}