Report Run event types v2

Reporting

Report Runs

Report Run event types

This is a list of all public thin events we currently send for updates to Report Run, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

v2.reporting.report_run.created

Occurs when a Report Run is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.
- reason.requestnullable object
  Information on the API request that instigated the event.
  reason.request.idstring
  ID of the API request that caused the event.
  reason.request.idempotency_keystring
  The idempotency key transmitted during the request.
- reason.typeenum
  Event reason type.
  Possible enum values
  request
  The event was published as the result of an API request.

related_objectnullable object
Object containing the reference to API resource relevant to the event.
- related_object.idstring
  Unique identifier for the object relevant to the event.
- related_object.typestring
  Object tag of the resource relevant to the event.
- related_object.urlstring
  URL to retrieve the resource.

typestring, value is "v2.reporting.report_run.created"
The type of the event.

Fetched attributes

changesobject
Changes the event makes to properties in the related object. See the Report Run object for the structure of before and after.
- changes.afternullable object
  Updated values of properties changed by the event. This is null for deletion events.
- changes.beforenullable object
  Values of properties before the event changes. This is null for creation events.

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-08-26T00:00:00.000Z",
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "type": "v2.reporting.report_run.created",
  "livemode": false,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_xxx",
      "idempotency_key": "xxx"
    }
  },
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  }
}

Event handler

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-08-26T00:00:00.000Z",
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "type": "v2.reporting.report_run.created",
  "livemode": false,
  "reason": {
    "type": "request",
    "request": {
      "id": "req_xxx",
      "idempotency_key": "xxx"
    }
  },
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  },
  "data": {},
  "changes": {
    "before": null,
    "after": {
      "created": "2025-08-26T00:00:00.000Z",
      "id": "reprun_test_xxx",
      "object": "v2.reporting.report_run",
      "report": "report_test_xxx",
      "report_name": "test report name",
      "report_parameters": {
        "interval_start": "2025-08-18T00:00:00.000Z",
        "interval_end": "2025-08-25T00:00:00.000Z"
      },
      "result": null,
      "result_options": {
        "compress_file": false
      },
      "status": "running",
      "status_details": {},
      "livemode": false
    }
  }
}

v2.reporting.report_run.failed

Occurs when a Report Run has failed to complete.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.
- reason.requestnullable object
  Information on the API request that instigated the event.
  reason.request.idstring
  ID of the API request that caused the event.
  reason.request.idempotency_keystring
  The idempotency key transmitted during the request.
- reason.typeenum
  Event reason type.
  Possible enum values
  request
  The event was published as the result of an API request.

related_objectnullable object
Object containing the reference to API resource relevant to the event.
- related_object.idstring
  Unique identifier for the object relevant to the event.
- related_object.typestring
  Object tag of the resource relevant to the event.
- related_object.urlstring
  URL to retrieve the resource.

typestring, value is "v2.reporting.report_run.failed"
The type of the event.

Fetched attributes

changesobject
Changes the event makes to properties in the related object. See the Report Run object for the structure of before and after.
- changes.afternullable object
  Updated values of properties changed by the event. This is null for deletion events.
- changes.beforenullable object
  Values of properties before the event changes. This is null for creation events.

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-08-26T00:00:00.000Z",
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "type": "v2.reporting.report_run.failed",
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  }
}

Event handler

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "created": "2025-08-26T00:00:00.000Z",
  "data": {},
  "reason": null,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  },
  "type": "v2.reporting.report_run.failed",
  "livemode": false,
  "changes": {
    "before": {
      "status": "running",
      "status_details": {}
    },
    "after": {
      "status": "failed",
      "status_details": {
        "failed": {
          "error_code": "file_size_above_limit",
          "error_message": "The file generated by this request exceeds the 5 GB limit."
        }
      }
    }
  }
}

v2.reporting.report_run.succeeded

Occurs when a Report Run has successfully completed.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.
- reason.requestnullable object
  Information on the API request that instigated the event.
  reason.request.idstring
  ID of the API request that caused the event.
  reason.request.idempotency_keystring
  The idempotency key transmitted during the request.
- reason.typeenum
  Event reason type.
  Possible enum values
  request
  The event was published as the result of an API request.

related_objectnullable object
Object containing the reference to API resource relevant to the event.
- related_object.idstring
  Unique identifier for the object relevant to the event.
- related_object.typestring
  Object tag of the resource relevant to the event.
- related_object.urlstring
  URL to retrieve the resource.

typestring, value is "v2.reporting.report_run.succeeded"
The type of the event.

Fetched attributes

changesobject
Changes the event makes to properties in the related object. See the Report Run object for the structure of before and after.
- changes.afternullable object
  Updated values of properties changed by the event. This is null for deletion events.
- changes.beforenullable object
  Values of properties before the event changes. This is null for creation events.

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-08-26T00:00:00.000Z",
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "type": "v2.reporting.report_run.succeeded",
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  }
}

Event handler

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "created": "2025-08-26T00:00:00.000Z",
  "data": {},
  "reason": null,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  },
  "type": "v2.reporting.report_run.succeeded",
  "livemode": false,
  "changes": {
    "before": {
      "status": "running"
    },
    "after": {
      "status": "succeeded"
    }
  }
}

v2.reporting.report_run.updated

Occurs when a Report Run is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.
- reason.requestnullable object
  Information on the API request that instigated the event.
  reason.request.idstring
  ID of the API request that caused the event.
  reason.request.idempotency_keystring
  The idempotency key transmitted during the request.
- reason.typeenum
  Event reason type.
  Possible enum values
  request
  The event was published as the result of an API request.

related_objectnullable object
Object containing the reference to API resource relevant to the event.
- related_object.idstring
  Unique identifier for the object relevant to the event.
- related_object.typestring
  Object tag of the resource relevant to the event.
- related_object.urlstring
  URL to retrieve the resource.

typestring, value is "v2.reporting.report_run.updated"
The type of the event.

Fetched attributes

changesobject
Changes the event makes to properties in the related object. See the Report Run object for the structure of before and after.
- changes.afternullable object
  Updated values of properties changed by the event. This is null for deletion events.
- changes.beforenullable object
  Values of properties before the event changes. This is null for creation events.

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-08-26T00:00:00Z",
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "type": "v2.reporting.report_run.updated",
  "livemode": false,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  }
}

Event handler

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "id": "evt_test_xxx",
  "object": "v2.core.event",
  "created": "2025-08-26T00:00:00Z",
  "data": {},
  "reason": null,
  "related_object": {
    "id": "reprun_test_xxx",
    "type": "v2.reporting.report_run",
    "url": "/v2/reporting/report_runs/reprun_test_xxx"
  },
  "type": "v2.reporting.report_run.updated",
  "livemode": false,
  "changes": {
    "before": {
      "status": "running"
    },
    "after": {
      "status": "succeeded"
    }
  }
}

Report Run event types v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

reason.requestnullable object

reason.request.idstring

reason.request.idempotency_keystring

reason.typeenum

related_objectnullable object

related_object.idstring

related_object.typestring

related_object.urlstring

typestring, value is "v2.reporting.report_run.created"

Fetched attributes

changesobject

changes.afternullable object

changes.beforenullable object

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

reason.requestnullable object

reason.request.idstring

reason.request.idempotency_keystring

reason.typeenum

related_objectnullable object

related_object.idstring

related_object.typestring

related_object.urlstring

typestring, value is "v2.reporting.report_run.failed"

Fetched attributes

changesobject

changes.afternullable object

changes.beforenullable object

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

reason.requestnullable object

reason.request.idstring

reason.request.idempotency_keystring

reason.typeenum

related_objectnullable object

related_object.idstring

related_object.typestring

related_object.urlstring

typestring, value is "v2.reporting.report_run.succeeded"

Fetched attributes

changesobject

changes.afternullable object

changes.beforenullable object

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

reason.requestnullable object

reason.request.idstring

reason.request.idempotency_keystring

reason.typeenum

related_objectnullable object

related_object.idstring

related_object.typestring

related_object.urlstring