Check Data Readiness

  • Updated on Apr 25, 2025
  • Published on Feb 25, 2025
Prev Next
Post
/data/ready

Check if event or aggregate data is ready and available for a topic, for a particular hour of the day.

Security
API Key
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key
Header parameter nameAccess-Token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Body parameters
object

Check Data Readiness Request Body

date
string Required

The start of the interval time range, in the format YYYY-MM-DD hh:mm:ss (must be within the past year).

Example2024-01-05 01:00:00
warehouse_meta_type
string Required

The type of data to check for.

Valid values[ "EVENT", "AGGREGATE" ]
ExampleEVENT
topic
string Required

The topic associated with the data.

Valid values[ "eo_impression", "eo_click", "eo_web_to_app_auto_redirect", "eo_branch_cta_view", "eo_open", "eo_install", "eo_reinstall", "eo_web_session_start", "eo_pageview", "eo_commerce_event", "eo_custom_event", "eo_content_event", "eo_dismissal", "eo_user_lifecycle_event", "cost", "skadnetwork_valid_messages", "eo_click_blocked", "eo_impression_blocked", "eo_install_blocked", "eo_reinstall_blocked", "eo_open_blocked", "eo_web_session_start_blocked", "eo_pageview_blocked", "eo_custom_event_blocked", "eo_content_event_blocked", "eo_commerce_event_blocked", "eo_user_lifecycle_event_blocked", "eo_branch_cta_view_blocked", "eo_web_to_app_auto_redirect_blocked", "eo_san_touch" ]
Exampleeo_open
app_id
integer Required

Your Branch App ID, found under Account Settings in your Branch Dashboard.

Example0
Responses
200

Data Readiness Status Successfully Retrieved

Result
"{\n  \"data_ready\": true,\n  \"date\": \"2024-01-05 01:00:00\"\n}\n"
object
data_ready
boolean

Whether the data is currently available.

ExampleTrue
date
string

The date associated with the data.

Example2024-01-05 01:00:00
400

Invalid Request

Result
"{\n    \"error\": {\n        \"message\": \"Topic is invalid or data retention for requested data has expired.\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_data_readiness_error)
message
string
ExampleReport type is invalid.
code
integer
Example400
500

Internal Server Error

Result
"{\n    \"error\": {\n        \"message\": \"Our product is failing to serve your request at this moment. Please try again later.\",\n        \"code\": 500\n    }\n}"
Expand All
object
error
object (inline_response_500_error)
message
string
ExampleInternal Server Error
code
integer
Example500