Retrieve an atlas

gethttps://api.faraday.ai/v1/atlases/{atlas_id}

Retrieve details on a specific atlas

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

atlas_idstring<uuid>required

The UUID of an atlas

Responses

200The requested atlas
archived_atstring<date-time>

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

connection_idstring<uuid>

The UUID of a connection - see /connections for more detail.

Only a subset of connection types can be configured for atlas inges...

Example: "5e0dfa56-2d52-4c06-a870-bc79c71e86a3"
countsobject

Location counts for this atlas. These will only be displayed if the atlas built successfully.

Properties of object
empty_geometryinteger

The number of rows whose geometry was read but encloses nowhere, such as an empty point. There is no place for such a row to put a location.

Example: 1
locatableinteger

The number of rows that produced a location. Rows that could not be located are not included in the atlas.

Example: 994
oversized_geometryinteger

The number of rows whose geometry describes too large an outline to hold on a location.

Example: 1
rowsinteger

The total number of rows in the source data.

Example: 1000
unreadable_geometryinteger

The number of rows whose geometry could not be read. The value was missing, was not a geometry, or gave coordinates outside the range of longitude and latitude — including coordinates in a projection other than WGS 84.

Example: 4
created_atstring<date-time>required

When this resource was created.

detected_columnsarray[object]

An array of columns

Example: 
[
  {
    "data_type": "text",
    "is_nullable": false,
    "name": "store_id"
  },
  {
    "data_type": "long",
    "is_nullable": true,
    "name": "sq_ft"
  }
]
Items of array[object]
data_typeone of 2 typesrequired

What type of data this field contains.

Properties of one of 2 types
One of:
stringenum:
"boolean""long""double""string""date"
fill_ratenumber

Count of non-null values divided by total count of values. 0.75 means 75% of the values are not null.

Example: 0.75
Minimum value: 0
Maximum value: 1
identifier_recommendationarray[string]

A list of recommended identity set keys to map this column to. Ordered by relevance.

is_nullablebooleanrequired
Example: true
namestringrequired

Name of the column found in the client data.

Example: "id"
Match pattern: ^[_a-zA-Z0-9][_a-zA-Z0-9 :/-]*$
idstring<uuid>required

A unique ID for this resource.

Example: "4c6c0f1e-0a58-4f1a-9c8a-52a1a1a3f5b7"
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.

namestringrequired

An identifying name for this atlas.

Match pattern: ^(?!\s*$).+
Maximum characters: 64
optionsdiscriminated type (type)required

Atlas connection options

Properties of discriminated type (type)
type
type#stringrequireddiscriminator
Value: "aws_aurora_mysql"
table_namestringrequired

Table name

Match pattern: ^[_a-zA-Z][a-zA-Z0-9_]+$
output_to_locationsobjectrequired

How to build a location out of each row of the source data. Each member below names a column in the source data.

Each location is placed by exactly one of three groups of columns: a geometry column (...

Additional properties: not allowed
Properties of object
citystring

The city of each location.

Example: "city"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
geometrystring

The geometry of each location, as GeoJSON or well-known text. Coordinates are decimal degrees in EPSG 4326 (WGS 84), and the geometry must be two-dimensional; a row whose geometry does not conform pro...

Example: "catchment"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
house_number_and_streetarray[string]

The street address lines of each location.

Example: ["address_1","address_2"]
latitudestring

The latitude of each location, in decimal degrees, EPSG 4326 (WGS 84).

Example: "lat"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
longitudestring

The longitude of each location, in decimal degrees, EPSG 4326 (WGS 84).

Example: "long"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
namestring

A human-readable label for each location.

Example: "store_name"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
postcodestring

The postcode of each location.

Example: "zip"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
propertiesarray[object]

Additional values to record on each location. Properties can be filtered on wherever an atlas' locations are used.

Items of array[object]
columnstring

The source column this property's value is read from. Mutually exclusive with value.

Example: "sq_ft"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
namestringrequired

The name this property is given on each location.

Example: "square_footage"
Match pattern: ^(?!\s*$).+
Maximum characters: 64
valuestring

A constant value for this property, shared by every location. Mutually exclusive with column.

Example: "vermont"
reference_keystring

An identifier for each location from an external system.

Reference keys must be unique within an atlas. Setting this enables filtering by location_reference_keys wherever an atlas' locations are used.

Example: "store_id"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
statestring

The state of each location.

Example: "state"
Match pattern: ^(?!\s*$).+
Maximum characters: 256
resource_typestringrequired

The type of this resource.

Example: "atlases"
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.

status_errorstring

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

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.

suggestionstring

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.

suggestionstring

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.

suggestionstring

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.

suggestionstring

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.

suggestionstring

A suggestion for fixing this error.

Tags

atlases