Object Media

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE
GET

List all object media previews

Required API key scopes

event_definition:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/object_media_previews
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "media_url": "string",
      "media_type": "string",
      "metadata": null,
      "uploaded_media_id": "d9247685-5182-404c-8ce1-80531369d18f",
      "exported_asset_id": "870fa602-abc0-4472-806a-6592120244c9",
      "event_definition_id": "7c2a0276-410c-43d2-9d47-51d1d50a32c6"
    }
  ]
}

Create object media previews

Required API key scopes

event_definition:write

Path parameters

  • project_id
    string

Request parameters

  • metadata
  • uploaded_media_id
    string
  • exported_asset_id
    string
  • event_definition_id
    string

Response


Example request

POST /api/projects/:project_id/object_media_previews
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/\
	-d created_at="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "media_url": "string",
  "media_type": "string",
  "metadata": null,
  "uploaded_media_id": "d9247685-5182-404c-8ce1-80531369d18f",
  "exported_asset_id": "870fa602-abc0-4472-806a-6592120244c9",
  "event_definition_id": "7c2a0276-410c-43d2-9d47-51d1d50a32c6"
}

Retrieve object media previews

Required API key scopes

event_definition:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

GET /api/projects/:project_id/object_media_previews/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "media_url": "string",
  "media_type": "string",
  "metadata": null,
  "uploaded_media_id": "d9247685-5182-404c-8ce1-80531369d18f",
  "exported_asset_id": "870fa602-abc0-4472-806a-6592120244c9",
  "event_definition_id": "7c2a0276-410c-43d2-9d47-51d1d50a32c6"
}

Update object media previews

Required API key scopes

event_definition:write

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • metadata
  • uploaded_media_id
    string
  • exported_asset_id
    string
  • event_definition_id
    string

Response


Example request

PATCH /api/projects/:project_id/object_media_previews/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/:id/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "media_url": "string",
  "media_type": "string",
  "metadata": null,
  "uploaded_media_id": "d9247685-5182-404c-8ce1-80531369d18f",
  "exported_asset_id": "870fa602-abc0-4472-806a-6592120244c9",
  "event_definition_id": "7c2a0276-410c-43d2-9d47-51d1d50a32c6"
}

Delete object media previews

Required API key scopes

event_definition:write

Path parameters

  • id
    string
  • project_id
    string

Example request

DELETE /api/projects/:project_id/object_media_previews/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/:id/

Example response

Status 204 No response body

Retrieve object media previews preferred for event

Get the preferred media preview for an event definition. Most recent user-uploaded, then most recent exported asset. Requires event_definition (query param).

Path parameters

  • project_id
    string

Response


Example request

GET /api/projects/:project_id/object_media_previews/preferred_for_event
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/object_media_previews/preferred_for_event/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "media_url": "string",
  "media_type": "string",
  "metadata": null,
  "uploaded_media_id": "d9247685-5182-404c-8ce1-80531369d18f",
  "exported_asset_id": "870fa602-abc0-4472-806a-6592120244c9",
  "event_definition_id": "7c2a0276-410c-43d2-9d47-51d1d50a32c6"
}

Community questions

Questions about this page? or post a community question.