---
title: "Keyword App Events"
method: POST
path: "/data/keyword/app-events"
tags: ["Keyword"]
---

# Keyword App Events

`POST /data/keyword/app-events`

## Request

- Base URL: `https://data.applyzer.com` (the document declares no server; this is the origin it was published from)
- URL: `https://data.applyzer.com/data/keyword/app-events`
- Auth: API key in header `Authorization`

This endpoint returns iOS in-app events found in App Store search results for a keyword.<br/>

Credit Cost: 5

## Request body

- object
  - `device` 'iphone' | 'ipad', required: iOS device to query.
  - `keyword` string, required: Search term
  - `language` string, required: Locale code such as en-US. The country suffix determines the store.
  - `market` 'IOS', required: App store market. App events are available for IOS.
  - `app` string: Optional iOS numeric app ID filter.
  - `days_back` integer: Number of days of keyword snapshots to scan. Defaults to 30 and is capped at 90.
  - `current_only` boolean: When true, only events currently running between startDate and endDate are returned. Defaults to true.
  - `max_docs` integer: Maximum number of keyword snapshot documents to scan. Defaults to 5000 and is capped at 20000.

## Response `200`

Successful operation

- object
  - `message` string: The response message
  - `response` object
    - `keyword` string: Search term
    - `keyword_id` integer: Keyword ID
    - `language` string: Locale code used for lookup
    - `market` string: App store market
    - `device` string: Device collection used
    - `date_range` object
      - `start` string: Start date scanned (YYYY-MM-DD)
      - `end` string: End date scanned (YYYY-MM-DD)
    - `total_apps_with_events` integer: Number of apps with events
    - `total_event_impressions` integer: Number of event appearances across scanned keyword snapshots
    - `apps` object[]: Apps with event activity sorted by total_event_impressions descending
      - `app_id` string: App ID/package
      - `app_name` string: App name
      - `artist` string: Publisher/developer name
      - `icon_url` string: App icon URL
      - `total_event_impressions` integer: Number of event appearances for this app
      - `unique_events` integer: Number of unique events found for this app
      - `events` object[]
        - `event_id` string: App event ID
        - `name` string: Event name
        - `badge_kind` string: App Store event badge kind
        - `kind` string: App Store event kind
        - `description` string: Event description
        - `start_date` string: Event start datetime
        - `end_date` string: Event end datetime
        - `artwork_url` string: Event artwork URL
        - `url` string: Event URL
        - `impressions` integer: Number of matching keyword snapshots where this event appeared

## Other responses

- `400`: Bad request
- `500`: Error

---

[API](https://skmtc.dev/applyzer/apis/applyzer-data-api.md) - [All operations](https://skmtc.dev/applyzer/apis/applyzer-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/applyzer/apis/applyzer-data-api/revisions/ffe6cc179bf5?raw)