Skip to main content

Regenerate metadata

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Endpoint​

/i/drill/regenerate_meta

Overview​

Regenerates Drill event and user-property metadata for one app.

Authentication​

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires drill Update permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
periodString or JSONNoPeriod used to limit source data. Defaults to 30days. Accepted keyword values are month, day, yesterday, hour, and prevMonth; relative values like 7days are also accepted. A JSON object with since is converted to [since, Date.now()].
wait_to_finishBoolean StringNoIf set, waits for regeneration to finish and returns Meta regeneration done. Otherwise returns immediately.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Response​

Async Success Response​

{
  "result": "Meta regeneration started"
}

Wait Response​

{
  "result": "Meta regeneration done"
}

Response Fields​

FieldTypeDescription
resultStringRegeneration status message.

Error Responses​

  • 404
{
  "result": "Missing parameter app_id"
}
  • 400
{
  "result": "Bad request parameter: period"
}

Behavior/Processing​

  • Parses period; invalid non-keyword periods return Bad request parameter: period.
  • Converts period.since objects to a timestamp range ending at request time.
  • Rebuilds the event list, then fixes Drill metadata for the app and selected period range.
  • Writes completion status to system logs with action meta_regeneration_finished.
  • Returns immediately unless wait_to_finish is provided.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.appsApp lookupReads target app metadata.
countly_drill.drill_metaDrill metadata modelRebuilds and fixes metadata documents.
countly_drill.drill_events{appId/hash}Source event dataReads Drill event data for metadata regeneration.
countly.systemlogsAudit trailStores meta_regeneration_finished completion status.

Examples​

Start async regeneration​

/i/drill/regenerate_meta?
  app_id=64f5c0d8f4f7ac0012ab3456&
  period=30days

Wait for regeneration​

/i/drill/regenerate_meta?
  app_id=64f5c0d8f4f7ac0012ab3456&
  period={"since":1735689600000}&
  wait_to_finish=true

Last Updated​

2026-04-17