Retrieve a migration

gethttps://api.faraday.ai/v1/migrations/{migration_id}
This endpoint is experimental and may change without notice.

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

migration_idstring<uuid>required

The UUID of a migration

Responses

200The requested migration
type
type#stringrequireddiscriminator
Value: "fig_v1_to_fig_v2"

How the two linked accounts sit in the account hierarchy, which decides what the account move does to it. siblings: the FIG v2 account already sits beside the FIG v1 account, so no account changes p...

Allowed values: siblings, fig_v2_is_child_of_fig_v1, fig_v1_is_child_of_fig_v2, unrelated
approved_atstring<date-time>

When a user approved the account move, recorded by the server. Provide
a non-null value via PATCH from either linked account to approve.
Repeated approval requests do not change the first approval.

archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

cohortsarray[object]

Paired FIG v1 and FIG v2 cohorts. Used to match payload columns whose names embed cohort ids when those names differ across the two accounts.

Items of array[object]
fig_v1_cohortobjectrequired

A resource referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

fig_v2_cohortobjectrequired

A resource referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

notesstring

Notes about this cohort pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

created_atstring<date-time>required

When this resource was created.

datasetsarray[object]

Paired FIG v1 and FIG v2 datasets included in the migration.

Items of array[object]
fig_v1_datasetobjectrequired

A dataset referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

The number of distinct people identified in the dataset's latest successful build.

Minimum value: 0
last_updated_output_atstring<date-time>

When the resource last built successfully.

The number of identified people matched to Faraday data in the dataset's latest successful build.

Minimum value: 0
namestringrequired

The resource's name.

row_countinteger

The number of rows in the dataset's latest successful build.

Minimum value: 0
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

fig_v2_datasetobjectrequired

A dataset referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

The number of distinct people identified in the dataset's latest successful build.

Minimum value: 0
last_updated_output_atstring<date-time>

When the resource last built successfully.

The number of identified people matched to Faraday data in the dataset's latest successful build.

Minimum value: 0
namestringrequired

The resource's name.

row_countinteger

The number of rows in the dataset's latest successful build.

Minimum value: 0
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

notesstring

Notes about this dataset pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

fig_v1_accountobjectrequired

The account that uses FIG v1. It must be related to the FIG v2 account in the account hierarchy, either sharing a parent with it or being its parent or child. Account names are not unique, so this req...

Additional properties: not allowed
Properties of object
idstring<uuid>required

The account's unique ID.

lookup_api_callsdictionary[string, integer]deprecated

Deprecated. Lookup API call counts belong on each Lookup API target (targets[].fig_v1_target.lookup_api_calls / targets[].fig_v2_target.lookup_api_calls), not on the account. Omitted on new checks.

Additional properties: allowed (values are integer)
namestringrequired

The account's name.

fig_v2_accountobjectrequired

The replacement account that uses FIG v2. Always the account that owns the migration.

Additional properties: not allowed
Properties of object
idstring<uuid>required

The account's unique ID.

lookup_api_callsdictionary[string, integer]deprecated

Deprecated. Lookup API call counts belong on each Lookup API target (targets[].fig_v1_target.lookup_api_calls / targets[].fig_v2_target.lookup_api_calls), not on the account. Omitted on new checks.

Additional properties: allowed (values are integer)
namestringrequired

The account's name.

finished_atstring<date-time>

When Faraday finished the account move: users moved to the FIG v2 account, any account whose parent had to change was moved, and the FIG v1 account was suspended. Most moves change no parent at all; see account_tree_relationship.

idstring<uuid>required

A unique ID for this resource.

last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

notesstring

Notes about this migration for the account's users.

outcomesarray[object]

Paired FIG v1 and FIG v2 outcomes. Used to match payload columns whose names embed outcome ids when those names differ across the two accounts.

Items of array[object]
fig_v1_outcomeobjectrequired

An outcome referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

roc_aucnumber

The ROC AUC from the outcome's latest completed run.

Minimum value: 0
Maximum value: 1
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

The total number of examples across the training sets used by the outcome's latest completed run.

Minimum value: 0
fig_v2_outcomeobjectrequired

An outcome referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

roc_aucnumber

The ROC AUC from the outcome's latest completed run.

Minimum value: 0
Maximum value: 1
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

The total number of examples across the training sets used by the outcome's latest completed run.

Minimum value: 0
notesstring

Notes about this outcome pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

persona_setsarray[object]

Paired FIG v1 and FIG v2 persona sets. Used to match payload columns whose names embed persona set ids when those names differ across the two accounts.

Items of array[object]
fig_v1_persona_setobjectrequired

A persona set referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

The number of personas in the persona set's latest completed run.

Minimum value: 0
idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

fig_v2_persona_setobjectrequired

A persona set referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

The number of personas in the persona set's latest completed run.

Minimum value: 0
idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

notesstring

Notes about this persona set pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

recommendersarray[object]

Paired FIG v1 and FIG v2 recommenders. Used to match payload columns whose names embed recommender ids when those names differ across the two accounts.

Items of array[object]
fig_v1_recommenderobjectrequired

A recommender referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

roc_aucnumber

The overall ROC AUC from the recommender's latest completed analysis.

Minimum value: 0
Maximum value: 1
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

fig_v2_recommenderobjectrequired

A recommender referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

namestringrequired

The resource's name.

roc_aucnumber

The overall ROC AUC from the recommender's latest completed analysis.

Minimum value: 0
Maximum value: 1
statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

notesstring

Notes about this recommender pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

resource_typestringrequired

The type of this resource.

Example: "migrations"
rolled_back_atstring<date-time>

When support restored the FIG v1 account after a completed migration.

statusstringrequired

The current state of this resource and any updates.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the status of this resource was last updated.

If this resource has status == "error", this will contain an error message.

Who has to act before a migration with status == "error" can run again. user means editing the migration clears it, support means only Faraday can. Omitted when Faraday will retry on its own. A ...

Allowed values: user, support
targetsarray[object]

Paired FIG v1 and FIG v2 targets included in the migration.

Items of array[object]
destination_mappingarray[object]

Matching destination options whose values differ between the two targets, such as table names or object keys.

Items of array[object]
fig_v1_valuestringrequired

The FIG v1 destination option value.

fig_v2_valuestringrequired

The matching FIG v2 destination option value.

optionstringrequired

Destination option name, for example table_name, object_key, file_name, or prefix.

scopestringrequired

Whether the option lives on the connection or on the target.

Allowed values: connection, target

Whether a Faraday team member checked configuration held by the target's external destination.

field_mappingarray[object]

Matching columns whose names differ between the two targets.

Items of array[object]

A FIG v1 target column. Omitted when FIG v2 emits a column FIG v1 never did, such as a scope's location proximity columns.

The matching FIG v2 target column. Omitted when FIG v1 emitted a column FIG v2 no longer produces.

fig_v1_targetobjectrequired

A target referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

lookup_api_callsdictionary[string, integer]

Lookup API call counts for this target for each of the last 7 days, keyed by YYYY-MM-DD. Present only for Lookup API targets, and only after the migration has checked usage.

Additional properties: allowed (values are integer)
namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

fig_v2_targetobjectrequired

A target referenced by a migration pair.

Additional properties: not allowed
Properties of object
archived_atstring<date-time>

When the resource was archived. Omitted for active resources.

idstring<uuid>required

The resource's unique ID.

last_updated_output_atstring<date-time>

When the resource last built successfully.

lookup_api_callsdictionary[string, integer]

Lookup API call counts for this target for each of the last 7 days, keyed by YYYY-MM-DD. Present only for Lookup API targets, and only after the migration has checked usage.

Additional properties: allowed (values are integer)
namestringrequired

The resource's name.

statusstring

The resource's current run state.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the resource's run state last changed.

Why the resource's latest run failed. Omitted unless status is error.

notesstring

Notes about this target pair for the account's users.

overriddenbooleanrequired

Whether a Faraday team member approved this pair despite an incomplete automated check.

Checks that compare a paired target and its replacement. Omitted until the checks have run.

Additional properties: not allowed
Properties of object
checked_atstring<date-time>required

When these checks last ran.

Whether renamed destination options (table name, object key, path, and similar) have a complete mapping.

Allowed values: not_required, complete, incomplete
destination_statusstringrequired

Whether the paired targets write to distinct destinations.

Allowed values: different, same, external_check_required, external_check_complete
field_mapping_statusstringrequired

Whether renamed output columns have a complete mapping.

Allowed values: not_required, complete, incomplete

Whether the FIG v1 target completed a successful run.

Whether the FIG v2 target completed a successful run.

statusstringrequired

ready means the pair passed every check, or a Faraday team member approved it anyway. needs_external_review means an external destination still needs review. blocked means an automated check failed.

Allowed values: ready, needs_external_review, blocked
updated_atstring<date-time>required

When this resource was last updated.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

Tags

migrations