SDK REST API Documentation

Find all the endpoints, resources and detailed documentation for Measure SDK REST APIs.

Contents#

• Resources
  • PUT /events
    • Usage Notes
    • Request Headers
    • Response Body
    • Request Body
    • Status Codes & Troubleshooting
  • PUT /builds
    • Usage Notes
    • Authorization & Content Type
    • Response Body
    • Request Body
      • Mappings
    • Status Codes & Troubleshooting
• GET /config
  • Usage Notes
  • Authorization & Content Type
  • Response Body
  • Cache Headers
  • Status Codes & Troubleshooting
• References

  • Attributes

  • User Defined Attributes

  • Attachments

  • Events

  • Event Types

    • anr
    • exception
    • string
    • gesture_long_click
    • gesture_scroll
    • gesture_click
    • http
    • network_change
    • app_exit
    • lifecycle_activity
    • lifecycle_fragment
    • lifecycle_view_controller
    • lifecycle_swift_ui
    • lifecycle_app
    • cold_launch
    • warm_launch
    • hot_launch
    • cpu_usage
    • memory_usage
    • memory_usage_absolute
    • low_memory
    • trim_memory
    • navigation
    • screen_view
    • custom
    • session_start

  • Traces

Resources#

• PUT /events - Send a batch of events, spans, attachments, metrics and traces via this endpoint.
• PUT /builds - Send build mappings and build sizes via this API.

PUT /events#

Ingests a batch of events, which can be of different types and can range across multiple sessions.

Usage Notes

• Maximum size of one request must not exceed 20 MiB. This limit is includes the combination of events and blob data.

• Each request must contain a unique UUIDv4 id, set as the header msr-req-id. If a request fails, the client must retry the same payload with the same msr-req-id to ensure idempotency.

• Each event must contain a nanosecond precision timestamp - "2023-08-24T14:51:38.000000534Z".

• Each request must not contain duplicate event ids.

• Each request must not contain duplicate span ids.

• Each span must contain a nanosecond precision start_time and end_time - "2023-08-24T14:51:38.000000534Z".

• Each event must have the following mandatory attributes:

  • attribute.installation_id
  • attribute.measure_sdk_version
  • attribute.thread_name
  • attribute.platform
  • attribute.app_version
  • attribute.app_build
  • attribute.app_unique_id

• Each span must have the following mandatory fields:

  • span_name
  • span_id
  • trace_id
  • session_id
  • status
  • start_time
  • end_time
  • attribute.installation_id
  • attribute.measure_sdk_version
  • attribute.platform
  • attribute.app_version
  • attribute.os_version
  • attribute.app_unique_id

• At least 1 event must be present in the events array field or 1 span must be present in the spans array field. Both arrays must not be empty.

• Successful response returns 202 Accepted.

• Response may contain a Retry-After: 60 header. If present, the client should retry the same request after 60 seconds. Note, that value indicating number of seconds may change.

• Idempotent based on msr-req-id. Previously seen requests matching by msr-req-id won't be re-processed.

Request Headers

1. Set the Measure API key in Authorization: Bearer <api-key> format

2. Set content type as Content-Type: multipart/form-data; boundary=SDKBoundary. The value of boundary can be any arbitrary string. Make sure the value doesn' change in a single request.

3. Set a unique UUIDv4 id as msr-req-id header.

4. Name of each field must be present in a Content-Disposition field. Example - Content-Disposition: form-data; name="event"

5. Each blob field must start with the blob- prefix followed by the id of the blob. Example - blob-14228029-d52d-45c7-8054-c8e9586d009a.

These headers must be present in each request.

<details> <summary>Request Headers - Click to expand</summary> </details>

Response Body

• For new event requests (Multipart)

  {
    "ok": "accepted"
  }
  

• For new event requests (JSON)

  When event request contain attachments, the response has the following shape.

  {
      "attachments": [
          {
              "id": "42306fd7-cb17-4fa4-88dd-b40ce1ce34c4",
              "type": "layout_snapshot",
              "filename": "snapshot.svg",
              "upload_url": "http://localhost:8080/proxy/attachments?payload=http%3A%2F%2Fminio%3A9000%2Fmsr-attachments-sandbox%2F42306fd7-cb17-4fa4-88dd-b40ce1ce34c4.svg%3FX-Amz-Algorithm%3DAWS4-HMAC-SHA256%26X-Amz-Credential%3Dminio%252F20251008%252Fus-east-1%252Fs3%252Faws4_request%26X-Amz-Date%3D20251008T101412Z%26X-Amz-Expires%3D604800%26X-Amz-SignedHeaders%3Dhost%253Bx-amz-meta-original_file_name%26x-id%3DPutObject%26X-Amz-Signature%3D6b5922cacd3e017871decfdc885101bd727bf5ba50eeca54b257e7a1bbb1bd14",
              "expires_at": "2025-10-15T10:14:12.870600803Z",
              "headers": {
                  "x-amz-meta-original_file_name": "snapshot.svg"
              }
          }
      ]
  }
  

  File upload requests must use the PUT http method. Example of a file upload request:

  curl -s -X PUT <upload_url> \
    --header 'x-amz-meta-original_file_name: somefile.tgz'
  

  In case event request does not contain attachments, the response has the following shape:

  {
    "attachments": null
  }
  

• For already seen msr-req-id

  {
    "ok": "accepted, known event request"
  }
  

• For another identical msr-req-id in progress

  // snip other headers
  Retry-After: 60
  

  {
    "warning": "a previous accepted request is in progress, retry after 60 seconds"
  }
  

[!NOTE]

A success response of 202 Accepted implies the server has accepted the request, but it may choose to not process & discard some events depending on various conditions.

• Failed requests have the following response shape

  {
    "error": "error message appears here"
  }
  

Request Body

The request body supports both multipart and application/json requests. Multipart requests will be deprecated in future versions, it only exists for backwards compatibility.

JSON request body

To understand the shape of the multipart/form-data payload, take a look at this sample request. You'll find detailed reference of events shapes below.

Example payload

<details> <summary>Expand</summary>

{"events":[{"id":"576aa557-2580-4bb6-9941-ba90df6c3c0e","session_id":"9321a0be-906e-436b-91af-b47fb2e81cde","user_triggered":false,"timestamp":"2025-10-07T12:13:01.51700000Z","type":"gesture_click","gesture_click":{"target":"androidx.compose.ui.platform.AndroidComposeView","target_id":"item_0","width":1080,"height":242,"x":619.959,"y":195.93066,"touch_down_time":75761066,"touch_up_time":75761126},"attachments":[{"id":"42306fd7-cb17-4fa4-88dd-b40ce1ce34c4","type":"layout_snapshot","name":"snapshot.svg"}],"attribute":{"thread_name":"main","platform":"android","user_id":null,"device_name":"emu64a16k","device_model":"sdk_gphone16k_arm64","device_manufacturer":"Google","device_type":"phone","device_is_foldable":false,"device_is_physical":false,"device_density_dpi":440,"device_width_px":1080,"device_height_px":2220,"device_density":2.75,"device_locale":"en-US","os_name":"android","os_version":"36","os_page_size":16,"app_version":"0.13.0-SNAPSHOT.debug","app_build":"29330652","app_unique_id":"sh.measure.sample","measure_sdk_version":"0.13.0-SNAPSHOT","installation_id":"4059d23f-34ce-4d2c-a015-bd8da0b101ae","network_type":"wifi","network_generation":"unknown","network_provider":"unknown","device_low_power_mode":false,"device_thermal_throttling_enabled":false},"user_defined_attribute":null}],"spans":[{"name":"activity.onCreate","trace_id":"d71f3d909689859469a7d9b38e605d56","span_id":"9f1890db9aedb305","parent_id":null,"session_id":"a2768feb-59cd-433f-bf00-d36ab297eddb","start_time":"2024-11-18T14:14:40.54500000Z","end_time":"2024-11-18T14:14:40.62000000Z","duration":75,"status":0,"attributes":{"thread_name":"main","user_id":null,"device_name":"emu64a16k","device_model":"sdk_gphone16k_arm64","device_manufacturer":"Google","device_locale":"en-US","os_name":"android","os_version":"35","platform":"android","app_version":"0.9.0-SNAPSHOT.debug","app_build":"900","app_unique_id":"sh.measure.sample","measure_sdk_version":"0.9.0-SNAPSHOT","installation_id":"2ee2d03e-ed76-43e7-8d63-9e146f1df618","network_type":"wifi","network_generation":"unknown","network_provider":"unknown"},"checkpoints":[]}]}

</details>

Multipart request body

To understand the shape of the multipart/form-data payload, take a look at this sample request. You'll find detailed reference of events shapes below.

Example payload

<details> <summary>Expand</summary>

--PieBoundary123456789012345678901234567
Content-Disposition: form-data; name="event"

{"type":"string","id":"233a2fbc-a0d1-4912-a92f-9e43e72afbc6","session_id":"633a2fbc-a0d1-4912-a92f-9e43e72afbc6","string":{"severity_text":"INFO","string":"This is a log from the Android logcat"},"timestamp":"2023-08-24T14:51:38.000000534Z","attribute":{"user_id":null,"installation_id":"322a2fbc-a0d1-1212-a92f-9e43e72afbc7","device_name":"sunfish","device_model":"SM-G950F","device_manufacturer":"samsung","device_type":"phone","device_is_foldable":true,"device_is_physical":false,"device_density_dpi":100,"device_width_px":480,"device_height_px":800,"device_density":2,"os_name":"android","os_version":"31","platform":"android","app_version":"1.0.1","app_build":"576358","app_unique_id":"com.example.app","network_type":"cellular","network_provider":"airtel","network_generation":"4g","measure_sdk_version":"0.0.1"},"user_defined_attribute":{"username":"alice","paid_user":true,"credit_balance":12345,"latitude":30.2661403415387},"attachments":[]}
--PieBoundary123456789012345678901234567
Content-Disposition: form-data; name="event"

{"type":"gesture_long_click","id":"9873a2fb-a0d1-4912-a92f-9e43e72afbc6","timestamp":"2023-08-24T14:51:40.000000534Z","session_id":"633a2fbc-a0d1-4912-a92f-9e43e72afbc6","gesture_long_click":{"target":"some_target_name","target_id":"some-target-id","touch_down_time":3394122,"touch_up_time":3395418,"width":1440,"height":996,"x":1234,"y":340},"attribute":{"user_id":null,"installation_id":"322a2fbc-a0d1-1212-a92f-9e43e72afbc7","device_name":"sunfish","device_model":"SM-G950F","device_manufacturer":"samsung","device_type":"phone","device_is_foldable":true,"device_is_physical":false,"device_density_dpi":100,"device_width_px":480,"device_height_px":800,"device_density":2,"os_name":"android","os_version":"31","platform":"android","app_version":"1.0.1","app_build":"576358","app_unique_id":"com.example.app","network_type":"cellular","network_provider":"airtel","network_generation":"4g","measure_sdk_version":"0.0.1"},"attachments":[{"id":"9e45a0bc-9277-468c-92f6-5eba2afc26e8","name":"screenshot-bla-bla.png","type":"screenshot","extension":"png", "timestamp": "2024-03-18T07:24:52.17200000Z"}]}
--PieBoundary123456789012345678901234567
Content-Disposition: form-data; name="event"

{"type":"gesture_scroll","id":"9873a2fb-a0d1-4912-a92f-9e43e72afbc6","timestamp":"2023-08-24T14:51:41.000000534Z","session_id":"633a2fbc-a0d1-4912-a92f-9e43e72afbc6","gesture_scroll":{"target":"some-scroll-target","target_id":"scroll-target-id","touch_down_time":3394122,"touch_up_time":3395418,"x":1234,"y":340,"end_x":1330,"end_y":370,"direction":"up"},"attribute":{"user_id":null,"installation_id":"322a2fbc-a0d1-1212-a92f-9e43e72afbc7","device_name":"sunfish","device_model":"SM-G950F","device_manufacturer":"samsung","device_type":"phone","device_is_foldable":true,"device_is_physical":false,"device_density_dpi":100,"device_width_px":480,"device_height_px":800,"device_density":2,"os_name":"android","os_version":"31","platform":"android","app_version":"1.0.1","app_build":"576358","app_unique_id":"com.example.app","network_type":"cellular","network_provider":"airtel","network_generation":"4g","measure_sdk_version":"0.0.1","thread_name":"main"},"attachments":[]}
--PieBoundary123456789012345678901234567
Content-Disposition: form-data; name="blob-9e45a0bc-9277-468c-92f6-5eba2afc26e8"


--PieBoundary123456789012345678901234567--
Content-Disposition: form-data; name="span"

{"name":"activity.onCreate","trace_id":"d71f3d909689859469a7d9b38e605d56","span_id":"9f1890db9aedb305","parent_id":null,"session_id":"a2768feb-59cd-433f-bf00-d36ab297eddb","start_time":"2024-11-18T14:14:40.54500000Z","end_time":"2024-11-18T14:14:40.62000000Z","duration":75,"status":0,"attributes":{"thread_name":"main","user_id":null,"device_name":"emu64a16k","device_model":"sdk_gphone16k_arm64","device_manufacturer":"Google","device_locale":"en-US","os_name":"android","os_version":"35","platform":"android","app_version":"0.9.0-SNAPSHOT.debug","app_build":"900","app_unique_id":"sh.measure.sample","measure_sdk_version":"0.9.0-SNAPSHOT","installation_id":"2ee2d03e-ed76-43e7-8d63-9e146f1df618","network_type":"wifi","network_generation":"unknown","network_provider":"unknown"},"checkpoints":[]}

--PieBoundary123456789012345678901234567--

</details>

Status Codes & Troubleshooting

List of HTTP status codes for success and failures.

<details> <summary>Status Codes - Click to expand</summary> </details>

PUT /builds#

Measure will use build information like mapping files, build sizes uploaded via this API for deobfuscation and to track app size changes.

This API only accepts the build metadata and does not actually upload the files. It returns pre-signed URLs for uploading the files directly to the returned URLs. For uploading the files, you can issue a standard http request using cURL or any other way using the upload_url as the URL and headers as the headers for the upload request.

Usage Notes

• Putting build_size for the same version_name, version_code and build_type combination replaces the last size with the latest size.
• Depending on the platform, build_type can be aab, apk for Android or ipa for iOS.
• Depending on the platform, mapping_type can be proguard for Android or dsym for iOS.
• mappings is optional. When mappings array is not present, only the build size information will be updated.
• Each mapping file for iOS must be gzipped tarball of dSYM bundles ending with a .tgz file extension.
• For mapping filename, only provide the filename, not a path.
• When mappings is present, the server returns a mappings array containing the pre-signed URL for uploading each mapping file.
• Each pre-signed mapping file upload URL has an expiry set which is the same as the expires_at field.
• Each mapping also contains a headers object containing all the headers key and value that should be added in the file upload request.
• Make sure all the headers are included in the file upload request, otherwise your file upload request will fail.
• File upload requests must use the PUT http method.

Example of a file upload request:

curl -s -X PUT <upload_url> \
  --header 'x-amz-meta-mapping_id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc' \
  --header 'x-amz-meta-original_file_name: somefile.tgz'

Authorization & Content Type

1. Set the Measure API key in Authorization: Bearer <api-key> format

2. Set the content type as Content-Type: application/json.

Response Body

• For request without mappings.

  {
    "ok": "uploaded build info"
  }
  

• For request with mappings.

  {
    "mappings": [
      {
        "id": "e2bbcad8-0566-44ea-af43-9dd114c64e8c",
        "type": "dsym",
        "filename": "DemoApp.app.dSYM.tgz",
        "upload_url": "http://localhost:9119/msr-symbols-sandbox/incoming/428f4448-080f-42d2-8b16-c74671a603a9.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20250813%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250813T005945Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host%3Bx-amz-meta-mapping_id%3Bx-amz-meta-original_file_name&x-id=PutObject&X-Amz-Signature=bc45a536a1660de12cb9056d6b6c978289e49b53fe6807b81662cd61c195caa1"
        "expires_at": "2025-08-13T01:59:45.577889184Z",
        "headers": {
          "x-amz-meta-mapping_id": "e2bbcad8-0566-44ea-af43-9dd114c64e8c",
          "x-amz-meta-original_file_name": "DemoApp.app.dSYM.tgz"
        }
      },
      {
        "id": "77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc",
        "type": "elf_debug",
        "filename": "app.symbols",
        "upload_url": "http://localhost:9119/msr-symbols-sandbox/incoming/77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20250813%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250813T005945Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host%3Bx-amz-meta-mapping_id%3Bx-amz-meta-original_file_name&x-id=PutObject&X-Amz-Signature=7e2e47a5598d0fe9facf6a3fbf7da5cf93a36866b19d1ff236603015529b0bc7"
        "expires_at": "2025-08-13T01:59:45.577980476Z",
        "headers": {
          "x-amz-meta-mapping_id": "77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc",
          "x-amz-meta-original_file_name": "app.symbols"
        }
      }
    ]
  }
  

Request Body

Payload must contain the app version info, build info and optional build mapping info.

Example payload

<details> <summary>Expand</summary>

{
  "version_name": "1.0",
  "version_code": "10",
  "build_size": 10241024,
  "build_type": "ipa",
  "mappings": [
    {
      "type": "dsym",
      "filename": "DemoApp.app.dSYM.tgz"
    },
    {
      "type": "elf_debug",
      "filename": "app.symbols"
    }
  ]
}

Mappings

Each mapping object has the following shape.

</details>

Status Codes & Troubleshooting

List of HTTP status codes for success and failures.

<details> <summary>Status Codes - Click to expand</summary> </details>

GET /config#

Fetches the latest SDK configuration for the app.

Usage Notes

• Successful response returns 200 OK.
• The response contains 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 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.

Authorization & Content Type

1. Set the Measure API key in Authorization: Bearer <api-key> format

2. Set the content type as Content-Type: application/json.

Response Body

• A successful response has the following shape.

  {
    "max_events_in_batch": 1000,
    "crash_timeline_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",
    "cpu_usage_interval": 5,
    "memory_usage_interval": 5,
    "crash_take_screenshot": true,
    "anr_take_screenshot": true,
    "anr_timeline_sampling_rate": 0.01,
    "launch_sampling_rate": 1,
    "gesture_click_take_snapshot": true,
    "http_disable_event_for_urls": [],
    "http_track_request_for_urls": [],
    "http_track_response_for_urls": [],
    "http_blocked_headers": []
  }
  

• Requests where If-None-Match matches the current Etag value. Then no response body is returned with 304 Not Modified.

• Failed requests have the following response shape

  {
    "error": "error message appears here"
  }
  

Cache Headers

• Etag: The Etag value representing the current configuration version.
• Cache-Control: Indicates how long the client can cache the configuration response.

Status Codes & Troubleshooting

List of HTTP status codes for success and failures.

<details> <summary>Status Codes - Click to expand</summary> </details>

References#

Exhaustive list of all JSON blocks/properties.

Attributes#

Events can contain the following attributes, some of which are mandatory.

User Defined Attributes#

Events can optionally contain attributes defined by the SDK user. A user_defined_attribute is a JSON key/value pair object. There are some constraints you should be aware of.

• An event may contain a maximum of 100 arbitrary user defined attributes.
• Key names should not exceed 256 characters.
• Key names must be unique in a user defined attribute key/value object.
• Key names must only contain alphabets, numbers, underscores and hyphens.
• Value can be regular String, Boolean or Number JSON types only.
• Number values when integer should be within the range of typical int64 type. -9223372036854775808 and 9223372036854775807.
• Number values when float should not exceed maximum value of typical float64 type. 1.7976931348623157e+308.
• String values should not exceed 256 characters.

{
  "id": "1c8a5e51-4d7d-4b2c-9be8-1abb31d38f90",
  "type": "gesture_click",
  "session_id": "633a2fbc-a0d1-4912-a92f-9e43e72afbc6",
  "timestamp": "2023-08-24T14:51:41.000000534Z",
  "user_triggered": false,
  "gesture_click": {
    // snip gesture_click fields
  },
  "attribute": {
    // snip attributes fields
  },
  "user_defined_attribute": {
    "username": "alice",
    "paid_user": true,
    "credit_balance": 12345,
    "latitude": 30.2661403415387
  },
  "attachments": {
    // snip attachment fields
  }
}

Attachments#

Attachments are arbitrary files associated with the session each having the following properties.

Events#

Event objects have the following shape. Additionally, each object must contain one of the event types of the same name. The following is an example event of type gesture_click.

{
  "id": "1c8a5e51-4d7d-4b2c-9be8-1abb31d38f90",
  "type": "gesture_click",
  "session_id": "633a2fbc-a0d1-4912-a92f-9e43e72afbc6",
  "timestamp": "2023-08-24T14:51:41.000000534Z",
  "user_triggered": false,
  "gesture_click": {
    // snip gesture_click fields
  },
  "attribute": {
    // snip attributes fields
  },
  "user_defined_attribute": {
    // snip user defined attributes fields
  },
  "attachments": {
    // snip attachment fields
  }
}

Event Types#

Each event object must be of one of the following types. Refer to the sample payload above to understand the shape of each object.

anr

Use the anr type for Application Not Responding events.

exception objects

Each exception object contains further fields.

thread objects

Each thread object contains further fields.

exception

Use the exception type for errors and crashes.

exception objects

Each exception object contains the thread information of the crashed thread and its stackframes along with the metadata required for symbolication.

thread objects

Each thread object contains further fields. Note: Only non-crashed threads are to be send in thread object.

frame objects

Each frame object contains further fields.

binary_image objects

Each binary_image object contains further fields.

error object.

The error object contains further fields. Applicable for Apple apps. Should not exceed 4096 bytes.

string

Use the string type when sending unstructured or structured logs. Make sure structured logs are in stringified JSON format.

gesture_long_click

Use the gesture_long_click body type for longer press and hold gestures.

gesture_scroll

Use the gesture_scroll body type for scroll events.

gesture_click

Use the gesture_click body type for taps or clicks.

http

Use the http body type for tracking a single HTTP network.

network_change

Use the network_change type for tracking changes to the network state of the device.

app_exit

Use the app_exit type for Application Exit events.

lifecycle_activity

Use the lifecycle_activity type for Android's activity lifecycle events

lifecycle_fragment

Use the lifecycle_fragment type for Android's fragment lifecycle events.

lifecycle_view_controller

Use the lifecycle_view_controller type for iOS ViewController lifecycle events.

lifecycle_swift_ui

Use the lifecycle_swift_ui type for iOS SwiftUI view lifecycle events.

lifecycle_app

Use the lifecycle_app type for app's lifecycle events.

cold_launch

Use the cold_launch type for Android cold app launch time.

warm_launch

Use the warm_launch type for Android warm app launch time.

hot_launch

Use the hot_launch type for Android hot app launch time.

cpu_usage

Use the cpu_usage type for CPU usage of a Linux based OS.

memory_usage

Use the memory_usage type for memory usage of JVM applications.

memory_usage_absolute

Use the memory_usage type for absolute memory usage.

low_memory

Use the low_memory type for a low memory event from the system.

[!NOTE]

This event is no longer tracked. The callback is deprecated and the general guidance is to rely on trim_memory events instead. Removed in Android SDK version 0.8.0. https://developer.android.com/reference/android/content/ComponentCallbacks#onLowMemory()

trim_memory

Use the trim_memory type for a trim memory event raised by Android.

navigation

Use the navigation type for navigation events.

[!IMPORTANT]

This event is no longer tracked and will be removed in future versions. Android SDK removed support for this event from v0.9.0 onwards.

screen_view

Use the screen_view type for screen view events.

custom

Use the custom type for custom events.

session_start

Use the session_start type to mark begining of a new session. This must be the first event by time in a session.

This event has no additional fields.

Traces#

A span is the fundamental building block of a trace. Spans have the following shape illustrated with an example of a app_startup span:

{
 "trace_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
 "span_id": "1234567890abcdef",
 "parent_id": null,
 "session_id": "633a2fbc-a0d1-4912-a92f-9e43e72afbc6",
 "name": "app_startup",
 "status": 0,
 "start_time": "2023-08-24T14:51:38.000000534Z",
 "end_time": "2023-08-24T14:51:38.000000834Z",
 "duration": 3000,
 "checkpoints": [
   {
     "name": "dagger_init_complete",
     "timestamp": "2023-08-24T14:51:38.000000634Z"
   }
 ],
 "attribute": {
   // snip attributes fields
 }
}

Spans contain the same set of attributes as events. Refer to the attributes section for details.