Retrieve a migration
https://api.faraday.ai/v1/migrations/{migration_id}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_TOKENpath parameters
The UUID of a migration
Responses
200The requested migration
type"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...
siblings, fig_v2_is_child_of_fig_v1, fig_v1_is_child_of_fig_v2, unrelatedapproved_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.
When this resource was created.
datasetsarray[object]Paired FIG v1 and FIG v2 datasets included in the migration.
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...
not allowedThe replacement account that uses FIG v2. Always the account that owns the migration.
not allowedfinished_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.
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.
notesstringNotes 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.
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.
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.
rolled_back_atstring<date-time>When support restored the FIG v1 account after a completed migration.
The current state of this resource and any updates.
"pending"new, starting, running, ready, errorstatus_changed_atstring<date-time>When the status of this resource was last updated.
status_errorstringIf this resource has status == "error", this will contain an error message.
status_needs_fix_fromstringWho 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 ...
user, supporttargetsarray[object]Paired FIG v1 and FIG v2 targets included in the migration.
When this resource was last updated.
400The request was invalid.
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...
"ERROR_TYPE"BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICTA unique ID for this error. Please include this in bug reports.
"082f9513-901c-4308-8081-902a8fe22d7e"validationErrorsarray[object]JSON Schema validation errors, if any.
401No API key was supplied.
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...
"ERROR_TYPE"BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICTA unique ID for this error. Please include this in bug reports.
"082f9513-901c-4308-8081-902a8fe22d7e"validationErrorsarray[object]JSON Schema validation errors, if any.
403Access to this resource was forbidden.
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...
"ERROR_TYPE"BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICTA unique ID for this error. Please include this in bug reports.
"082f9513-901c-4308-8081-902a8fe22d7e"validationErrorsarray[object]JSON Schema validation errors, if any.
404The requested resource ID was not found.
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...
"ERROR_TYPE"BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICTA unique ID for this error. Please include this in bug reports.
"082f9513-901c-4308-8081-902a8fe22d7e"validationErrorsarray[object]JSON Schema validation errors, if any.
500An internal server error occurred.
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...
"ERROR_TYPE"BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICTA unique ID for this error. Please include this in bug reports.
"082f9513-901c-4308-8081-902a8fe22d7e"validationErrorsarray[object]JSON Schema validation errors, if any.
Tags
Test request
Request snippet
curl -X GET 'https://api.faraday.ai/v1/migrations/{migration_id}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY'Example response
{
"account_tree_relationship": "siblings",
"approved_at": "2024-01-01T12:00:00Z",
"archived_at": "2024-01-01T12:00:00Z",
"cohorts": [
{
"fig_v1_cohort": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"fig_v2_cohort": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"notes": "string",
"overridden": true
}
],
"created_at": "2024-01-01T12:00:00Z",
"datasets": [
{
"fig_v1_dataset": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"identified_count": 0,
"last_updated_output_at": "2024-01-01T12:00:00Z",
"matched_count": 0,
"name": "string",
"row_count": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"fig_v2_dataset": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"identified_count": 0,
"last_updated_output_at": "2024-01-01T12:00:00Z",
"matched_count": 0,
"name": "string",
"row_count": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"notes": "string",
"overridden": true
}
],
"fig_v1_account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"lookup_api_calls": {
"key": 0
},
"name": "string"
},
"fig_v2_account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"lookup_api_calls": {
"key": 0
},
"name": "string"
},
"finished_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_read_input_at": "2024-01-01T12:00:00Z",
"last_updated_config_at": "2024-01-01T12:00:00Z",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"notes": "string",
"outcomes": [
{
"fig_v1_outcome": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"roc_auc": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string",
"training_set_size": 0
},
"fig_v2_outcome": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"roc_auc": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string",
"training_set_size": 0
},
"notes": "string",
"overridden": true
}
],
"persona_sets": [
{
"fig_v1_persona_set": {
"archived_at": "2024-01-01T12:00:00Z",
"cluster_count": 0,
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"fig_v2_persona_set": {
"archived_at": "2024-01-01T12:00:00Z",
"cluster_count": 0,
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"notes": "string",
"overridden": true
}
],
"recommenders": [
{
"fig_v1_recommender": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"roc_auc": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"fig_v2_recommender": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"name": "string",
"roc_auc": 0,
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"notes": "string",
"overridden": true
}
],
"resource_type": "migrations",
"rolled_back_at": "2024-01-01T12:00:00Z",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string",
"status_needs_fix_from": "user",
"targets": [
{
"destination_mapping": [
{
"fig_v1_value": "string",
"fig_v2_value": "string",
"option": "string",
"scope": "connection"
}
],
"external_configuration_checked": true,
"field_mapping": [
{
"fig_v1_column_name": "string",
"fig_v2_column_name": "string"
}
],
"fig_v1_target": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"lookup_api_calls": {
"key": 0
},
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"fig_v2_target": {
"archived_at": "2024-01-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"last_updated_output_at": "2024-01-01T12:00:00Z",
"lookup_api_calls": {
"key": 0
},
"name": "string",
"status": "pending",
"status_changed_at": "2024-01-01T12:00:00Z",
"status_error": "string"
},
"notes": "string",
"overridden": true,
"push_readiness": {
"checked_at": "2024-01-01T12:00:00Z",
"destination_mapping_status": "not_required",
"destination_status": "different",
"field_mapping_status": "not_required",
"fig_v1_target_succeeded": true,
"fig_v2_target_succeeded": true,
"status": "ready"
}
}
],
"type": "fig_v1_to_fig_v2",
"updated_at": "2024-01-01T12:00:00Z"
}