Measure Config API

Fetch the SDK configuration for the app.

GitHub OpenAPI

Operations 1

GET /config Fetch the SDK configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/measure-sh:measure-sh-config-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

measure-sh-config-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Measure SDK Config API
  version: 1.0.0
  description: 'Reference for the Measure SDK ingestion REST API. Events, builds, config,

    attachments, traces and authentication.


    All endpoints authenticate with a Measure API key sent as a bearer token

    in the `Authorization` header:


    ```

    Authorization: Bearer

    ```


    Endpoints:


    - **PUT `/events`**: send a batch of events, spans, attachments, metrics and traces.

    - **PUT `/builds`**: send build mappings and build sizes.

    - **PUT `/builds/ota`**: send Over-The-Air patch mappings (CodePush, Shorebird) keyed by `patch_id`.

    - **GET `/config`**: fetch the latest SDK configuration for the app.'
servers:
- url: https://{host}
  description: 'Measure ingestion server. Use the API URL configured for your app in the Measure dashboard; self-hosted deployments use their own origin.

    '
  variables:
    host:
      default: your-measure-instance.example
      description: Hostname of the Measure deployment's ingestion endpoint.
- url: http://localhost:8085
  description: Self-hosted Measure ingestion origin (local default)
security:
- measureApiKey: []
tags:
- name: Config
  description: Fetch the SDK configuration for the app.
paths:
  /config:
    get:
      operationId: getSdkConfig
      tags:
      - Config
      summary: Fetch the SDK configuration
      description: 'Fetches the latest SDK configuration for the app.


        Usage notes:


        - A successful response returns `200 OK`.

        - The response contains an `ETag` header which must be used for caching. The

        client must send the `If-None-Match` header with the same `ETag` value in

        subsequent requests to this endpoint.

        - If the configuration has not changed, the server returns a

        `304 Not Modified` response with no body.

        - The response contains a `Cache-Control` header which indicates how long

        the client can cache the configuration response. Once the cache expires,

        the client must revalidate the configuration by sending a request with the

        `If-None-Match` header.'
      parameters:
      - name: If-None-Match
        in: header
        required: false
        description: 'The `ETag` value received from a previous response. When it matches the current configuration version, the server returns `304 Not Modified`.

          '
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved a config.
          headers:
            ETag:
              description: 'The ETag value representing the current configuration version.

                '
              schema:
                type: string
            Cache-Control:
              description: 'Indicates how long the client can cache the configuration response.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  max_events_in_batch:
                    type: integer
                    description: Maximum number of events and spans in a batch.
                  error_replay_duration:
                    type: integer
                    description: 'The duration of session timeline collected with errors.

                      '
                  anr_timeline_duration:
                    type: integer
                    description: The duration of session timeline collected with ANRs.
                  bug_report_timeline_duration:
                    type: integer
                    description: 'The duration of session timeline collected with bug reports.

                      '
                  trace_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for all traces.
                  journey_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: 'Sampling rate for sessions that should report journey events, read by SDKs before Android 0.23.0 and iOS 0.15.0. Newer SDKs sample journey events with `analytics_sampling_rate`.

                      '
                  screenshot_mask_level:
                    type: string
                    enum:
                    - all_text_and_media
                    - all_text
                    - all_text_except_clickable
                    - sensitive_fields_only
                    description: Screenshot masking level.
                  log_autocollect_enabled:
                    type: boolean
                    description: 'Whether the SDK automatically collects platform logs. Defaults to `false`.

                      '
                  log_min_severity:
                    type: integer
                    description: 'Minimum severity number of logs to collect. Logs below this number are dropped. `debug` 8, `info` 12, `warning` 16, `error` 20, `fatal` 24.

                      '
                  log_ignore_patterns:
                    type: array
                    items:
                      type: string
                    description: 'Regex patterns. Logs whose body matches any pattern are discarded.

                      '
                  cpu_usage_interval:
                    type: integer
                    description: CPU usage measurement interval.
                  memory_usage_interval:
                    type: integer
                    default: 5
                    description: Memory usage measurement interval in seconds while the app is in the foreground.
                  memory_usage_background_interval:
                    type: integer
                    default: 10
                    description: 'Memory usage measurement interval in seconds while the app is in the background. Android only, iOS/iPadOS stops collecting in the background.

                      '
                  memory_usage_session_sampling_rate:
                    type: number
                    default: 0.01
                    minimum: 0
                    maximum: 100
                    description: Percentage of sessions that report memory usage on Android and iOS/iPadOS.
                  error_fatal_take_screenshot:
                    type: boolean
                    description: Whether to take screenshot on fatal error.
                  error_fatal_replay_enabled:
                    type: boolean
                    description: 'Whether to collect a session replay with fatal errors, the ones that terminated the app.

                      '
                  error_unhandled_replay_enabled:
                    type: boolean
                    description: 'Whether to collect a session replay with unhandled errors, the ones that were not caught but did not terminate the app.

                      '
                  crash_timeline_duration:
                    type: integer
                    deprecated: true
                    description: 'Alias of `error_replay_duration`, served for SDKs released before the rename.

                      '
                  crash_take_screenshot:
                    type: boolean
                    deprecated: true
                    description: 'Alias of `error_fatal_take_screenshot`, served for SDKs released before the rename.

                      '
                  error_handled_replay_enabled:
                    type: boolean
                    description: 'Whether to collect a session replay with handled errors.

                      '
                  error_fatal_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for fatal errors.
                  error_unhandled_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for unhandled errors.
                  error_handled_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for handled errors.
                  anr_take_screenshot:
                    type: boolean
                    description: Whether to take screenshot on ANR.
                  app_hang_threshold_millis:
                    type: integer
                    description: 'How long the main thread must stay blocked before it is reported as an app hang. iOS only.

                      '
                  app_hang_timeline_duration:
                    type: integer
                    description: 'The duration of session timeline collected with app hangs.

                      '
                  app_hang_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for app hangs.
                  app_hang_replay_enabled:
                    type: boolean
                    description: Whether to collect session replay with app hangs.
                  launch_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: 'Sampling rate for launch events: cold_launch, warm_launch and hot_launch.

                      '
                  gesture_click_take_snapshot:
                    type: boolean
                    description: Whether to take snapshot with gesture_click event.
                  http_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for HTTP events.
                  http_disable_event_for_urls:
                    type: array
                    items:
                      type: string
                    description: URLs to disable HTTP event tracking.
                  http_track_request_for_urls:
                    type: array
                    items:
                      type: string
                    description: 'URLs to capture full HTTP request (body and headers).

                      '
                  http_track_response_for_urls:
                    type: array
                    items:
                      type: string
                    description: 'URLs to capture full HTTP response (body and headers).

                      '
                  http_blocked_headers:
                    type: array
                    items:
                      type: string
                    description: HTTP header names to never capture.
                  profile_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: Sampling rate for profile events.
                  analytics_sampling_rate:
                    type: number
                    minimum: 0
                    maximum: 100
                    description: 'Sampling rate for installations that should report the event types in `analytics_event_types`.

                      '
                  analytics_event_types:
                    type: array
                    items:
                      type: string
                    description: 'Event types sampled with `analytics_sampling_rate`. Fixed by Measure for every app.

                      '
              example:
                max_events_in_batch: 1000
                error_replay_duration: 300
                anr_timeline_duration: 300
                bug_report_timeline_duration: 300
                trace_sampling_rate: 0.001
                journey_sampling_rate: 0.001
                screenshot_mask_level: all_text
                log_autocollect_enabled: false
                log_min_severity: 16
                log_ignore_patterns: []
                cpu_usage_interval: 5
                memory_usage_interval: 5
                memory_usage_background_interval: 10
                memory_usage_session_sampling_rate: 0.01
                error_fatal_take_screenshot: true
                error_fatal_replay_enabled: true
                error_unhandled_replay_enabled: false
                error_handled_replay_enabled: false
                error_fatal_sampling_rate: 100
                error_unhandled_sampling_rate: 100
                error_handled_sampling_rate: 0
                crash_timeline_duration: 300
                crash_take_screenshot: true
                anr_take_screenshot: true
                app_hang_threshold_millis: 2000
                app_hang_timeline_duration: 300
                app_hang_sampling_rate: 100
                app_hang_replay_enabled: true
                launch_sampling_rate: 1
                gesture_click_take_snapshot: true
                http_sampling_rate: 100
                http_disable_event_for_urls: []
                http_track_request_for_urls: []
                http_track_response_for_urls: []
                http_blocked_headers: []
                profile_sampling_rate: 100
                analytics_sampling_rate: 100
                analytics_event_types:
                - custom
                - lifecycle_activity
                - lifecycle_fragment
                - lifecycle_view_controller
                - lifecycle_swift_ui
                - screen_view
        '304':
          description: The config has not changed, the body will be empty.
        '400':
          description: 'Request is malformed or does not meet one or more acceptance criteria. Check the `error` field for more details.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '401':
          description: Either the Measure API key is not present or has expired.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '404':
          description: No app found for this API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '429':
          description: 'Rate limit has exceeded. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
        '500':
          description: 'Measure server encountered an unfortunate error. Report this to your server administrator.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '503':
          description: 'Measure server is temporarily unavailable. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
components:
  securitySchemes:
    measureApiKey:
      type: http
      scheme: bearer
      description: 'Measure API key for the app, sent as `Authorization: Bearer <api-key>`.

        The app is determined from the API key.

        '