Hit

GET /v1/entities/hit/{entity_id}

Retrieves a specific hit.

Request Parameters

Location Parameter Type Required/ Optional Description
path entity_id string 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.attributes object
data.attributes.name string The string name of the hit
data.attributes.previews array
data.attributes.previews[].content_type string enum The content type of the previews, currently audio/mp3.
data.attributes.previews[].url string The URL of the hit’s preview file
data.id string The string id of the hit, used in the hit field of a Hit
data.links object
data.links.self string The URL of this hit
data.type string The type of data (entity_hit in this case)
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",
            "previews": [
                {
                    "content_type": "audio/mp3",
                    "url": "https://public-cdn.ampermusic.com/hits/previews/cymbal_crash_v1.mp3"
                }
            ]
        },
        "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"
    }
}