artifacts

Record an artifacts cache usage event

Changed on

Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are HIT and MISS. The source is either LOCAL the cache event was on the users filesystem cache or REMOTE if the cache event is for a remote cache. When the event is a HIT the request also accepts a number duration which is the time taken to generate the artifact in the cache.

post/v8/artifacts/events

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v8/artifacts/events
  • Auth: HTTP bearer

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Headers

x-artifact-client-cistring

The continuous integration or delivery environment where this artifact is downloaded.

Example:VERCEL
x-artifact-client-interactiveinteger

1 if the client is an interactive shell. Otherwise 0

Request body

sessionIdstring required

A UUID (universally unique identifer) for the session that generated this event.

source'LOCAL' | 'REMOTE' required

One of LOCAL or REMOTE. LOCAL specifies that the cache event was from the user's filesystem cache. REMOTE specifies that the cache event is from a remote cache.

event'HIT' | 'MISS' required

One of HIT or MISS. HIT specifies that a cached artifact for hash was found in the cache. MISS specifies that a cached artifact with hash was not found.

hashstring required

The artifact hash

durationnumber

The time taken to generate the artifact. This should be sent as a body parameter on HIT events.

Example request

[
  {
    "hash": "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    "duration": 400
  }
]

Response

Success. Event recorded.

Changes

  • 099fbe1f521cRevision changes
    • info

      added the non-success response with the status

  • 606993b34ea5Revision changes
    • warning

      deleted the header request parameter 'x-Artifact-Client-Ci'

    • warning

      deleted the header request parameter 'x-Artifact-Client-Interactive'

    • info

      added the new optional header request parameter x-artifact-client-ci

    • info

      added the new optional header request parameter x-artifact-client-interactive