Method calls

Note

Requests are sent to the AppMetrica API over the HTTPS protocol.

Requests use the following format:

method_type https://api.appmetrica.yandex.com/API_section/version/method_name.result_format?parameters
  • method type ― GET, POST, PUT or DELETE.
  • API_section — The name of the API section that the action applies to.
  • version — The number of the current version of the API.
  • method_name — The URL of the resource that the action applies to.
  • result_format — Optional part of the request. It sets the result format. By default, data is transmitted in JSON format.
  • parameters — Required and optional request parameters.

AI agent call context

If an API method is called by an AI agent to solve a user's task, we recommend adding two optional UTM parameters to the URL:

  • utm_source=ai_agent — indicates that the request is made by an AI agent.
  • utm_content — briefly describes the task the user wants to solve, for example, compare_monthly_retention for comparing retention by month.

This context will help us better understand your tasks and develop analytics so that you can get the answers you need more easily and quickly.

The parameters do not affect the API response. If they are not provided, the request will be processed in the same way as with them.

Example:

/stat/v1/data?ids=1111&utm_source=ai_agent&utm_content=compare_monthly_retention

If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.

Contact support Suggest an improvement for documentation