{/* This page is auto-generated by scripts/build-deprecation-docs.ts — do not edit manually. */}

This page lists all deprecated fields, arguments, and enum values in the Lumar GraphQL API schema. Use it to identify what needs migrating and find the recommended replacements.

:::tip
See [API Versioning](versioning) for how the API evolves and how deprecations are handled.
:::

## Summary

| Category    |   Count |
| ----------- | ------: |
| Queries     |       3 |
| Mutations   |       2 |
| Types       |      48 |
| Input Types |      22 |
| Arguments   |       1 |
| Enum Values |      24 |
| **Total**   | **100** |

## Queries

### `Query`

| Field                             | Type                               | Deprecation Reason                                                                     |
| --------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------- |
| `datasources`                     | `[Datasource!]!`                   | Use getDatasources instead.                                                            |
| `getGlobalCustomMetricContainers` | `CustomMetricContainerConnection!` | Use Account.getGlobalCustomMetricContainers or Project.getGlobalCustomMetricContainers |
| `getHealthScoresForCrawls`        | `CrawlHealthScoreConnection!`      | Use getHealthScores query instead.                                                     |

## Mutations

### `Mutation`

| Field                        | Type                    | Deprecation Reason                                                         |
| ---------------------------- | ----------------------- | -------------------------------------------------------------------------- |
| `createProject`              | `CreateProjectPayload!` | Use createSEOProject instead                                               |
| `createSessionUsingUsername` | `Session!`              | To authenticate with API use `createSessionUsingUserKey` mutation instead. |

## Types

### `AiVisibilityPageRun`

| Field     | Type         | Deprecation Reason                                                       |
| --------- | ------------ | ------------------------------------------------------------------------ |
| `metrics` | `JSONObject` | Use individual score fields (precisionScore, recallScore, etc.) instead. |

### `Crawl`

| Field                | Type       | Deprecation Reason                                                             |
| -------------------- | ---------- | ------------------------------------------------------------------------------ |
| `brokenAt`           | `DateTime` | Legacy timestamp. No longer in use.                                            |
| `erroredAt`          | `DateTime` | Legacy timestamp. No longer in use.                                            |
| `errorMessage`       | `String`   | Legacy field. No longer in use.                                                |
| `isContainer`        | `Boolean!` | No longer in use.                                                              |
| `processingAt`       | `DateTime` | Legacy timestamp. No longer in use. Use Crawl.crawledAt instead.               |
| `startedByApi`       | `Boolean!` | Legacy setting. No longer in use.                                              |
| `status`             | `String!`  | Use statusEnum instead.                                                        |
| `useRobotsOverwrite` | `Boolean!` | Legacy setting. No longer in use. Use CrawlSetting.useRobotsOverwrite instead. |

### `CrawlParquetFile`

| Field       | Type       | Deprecation Reason                                                  |
| ----------- | ---------- | ------------------------------------------------------------------- |
| `expiresAt` | `DateTime` | File URLs have 1 week expiry and are available as long as Crawl is. |

### `CrawlSetting`

| Field                             | Type                              | Deprecation Reason                                                              |
| --------------------------------- | --------------------------------- | ------------------------------------------------------------------------------- |
| `googleAnalytics4ProjectProperty` | `GoogleAnalytics4ProjectProperty` | GA4 settings flattened on CrawlSetting entity. Prefixed with `googleAnalytics4` |

### `CustomMetricContainer`

| Field            | Type                                      | Deprecation Reason                                      |
| ---------------- | ----------------------------------------- | ------------------------------------------------------- |
| `linksProducer`  | `Boolean`                                 | Moved to CustomMetricContainerVersion handlers options. |
| `linksProducers` | `[CustomMetricContainerKeyLinkProducer!]` | Moved to CustomMetricContainerVersion handlers options. |
| `outputType`     | `CustomMetricContainerOutputType`         | Moved to CustomMetricContainerVersion handlers options. |
| `tableType`      | `CustomMetricContainerTableType`          | Moved to CustomMetricContainerVersion handlers options. |
| `tableTypes`     | `[CustomMetricContainerKeyTableType!]`    | Moved to CustomMetricContainerVersion handlers options. |
| `timeoutMs`      | `Int`                                     | Moved to CustomMetricContainerVersion handlers options. |

### `CustomMetricContainerVersion`

| Field               | Type         | Deprecation Reason                                      |
| ------------------- | ------------ | ------------------------------------------------------- |
| `avroSchema`        | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `avroSchemas`       | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `entrypoint`        | `String`     | Moved to CustomMetricContainerVersion handlers options. |
| `fieldsMapping`     | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `fieldsMappings`    | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `handler`           | `String`     | Moved to CustomMetricContainerVersion handlers options. |
| `metricsMetadata`   | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `outputSchema`      | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `outputSchemaPath`  | `String`     | Moved to CustomMetricContainerVersion handlers options. |
| `outputSchemaPaths` | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `outputSchemas`     | `JSONObject` | Moved to CustomMetricContainerVersion handlers options. |
| `timeoutMs`         | `Int`        | Moved to CustomMetricContainerVersion handlers options. |

### `Datasource`

| Field     | Type      | Deprecation Reason          |
| --------- | --------- | --------------------------- |
| `code`    | `String!` | Use datasourceCode instead. |
| `version` | `Int!`    | No longer used.             |

### `Project`

| Field              | Type        | Deprecation Reason               |
| ------------------ | ----------- | -------------------------------- |
| `hasAccessibility` | `Boolean!`  | Use moduleCode                   |
| `limitUrlsMax`     | `Int!`      | Renamed to limitPagesMax.        |
| `maxContentSize`   | `Int!`      | Renamed to maxBodyContentLength. |
| `sitePrimary`      | `String!`   | Renamed to primaryDomain.        |
| `siteTest`         | `String`    | Renamed to testSiteDomain.       |
| `urlsExcluded`     | `[String!]` | Renamed to excludeUrlPatterns.   |
| `urlsIncluded`     | `[String!]` | Renamed to includeUrlPatterns.   |

### `TestSuite`

| Field            | Type        | Deprecation Reason               |
| ---------------- | ----------- | -------------------------------- |
| `limitUrlsMax`   | `Int!`      | Renamed to limitPagesMax.        |
| `maxContentSize` | `Int!`      | Renamed to maxBodyContentLength. |
| `sitePrimary`    | `String!`   | Renamed to primaryDomain.        |
| `siteTest`       | `String`    | Renamed to testSiteDomain.       |
| `urlsExcluded`   | `[String!]` | Renamed to excludeUrlPatterns.   |
| `urlsIncluded`   | `[String!]` | Renamed to includeUrlPatterns.   |

### `UrlFileUpload`

| Field                  | Type         | Deprecation Reason                                                |
| ---------------------- | ------------ | ----------------------------------------------------------------- |
| `customUploadTemplate` | `JSONObject` | Use UrlFileUploadType.uploadTemplate as a base for customization. |
| `processingFeedback`   | `String`     | Legacy field. No longer in use.                                   |

### `User`

| Field      | Type     | Deprecation Reason      |
| ---------- | -------- | ----------------------- |
| `username` | `String` | Use User.email instead. |

### `UserInfo`

| Field      | Type     | Deprecation Reason          |
| ---------- | -------- | --------------------------- |
| `username` | `String` | Use UserInfo.email instead. |

## Input Types

### `CopyCustomDashboardCollectionInput`

| Field       | Type       | Deprecation Reason |
| ----------- | ---------- | ------------------ |
| `accountId` | `ObjectID` | No longer used.    |

### `CrawlConnectionFilterInput`

| Field                | Type                           | Deprecation Reason                                                             |
| -------------------- | ------------------------------ | ------------------------------------------------------------------------------ |
| `brokenAt`           | `ConnectionDateFilterInput`    | Legacy timestamp. No longer in use.                                            |
| `erroredAt`          | `ConnectionDateFilterInput`    | Legacy timestamp. No longer in use.                                            |
| `errorMessage`       | `ConnectionStringFilterInput`  | Legacy field. No longer in use.                                                |
| `isContainer`        | `ConnectionBooleanFilterInput` | No longer in use.                                                              |
| `processingAt`       | `ConnectionDateFilterInput`    | Legacy timestamp. No longer in use. Use Crawl.crawledAt instead.               |
| `startedByApi`       | `ConnectionBooleanFilterInput` | Legacy setting. No longer in use.                                              |
| `useRobotsOverwrite` | `ConnectionBooleanFilterInput` | Legacy setting. No longer in use. Use CrawlSetting.useRobotsOverwrite instead. |

### `CreateAccessibilityProjectInput`

| Field          | Type  | Deprecation Reason         |
| -------------- | ----- | -------------------------- |
| `limitUrlsMax` | `Int` | Use limitLevelsMax instead |

### `CreateProjectInput`

| Field          | Type  | Deprecation Reason         |
| -------------- | ----- | -------------------------- |
| `limitUrlsMax` | `Int` | Use limitLevelsMax instead |

### `CreateSiteSpeedProjectInput`

| Field          | Type  | Deprecation Reason         |
| -------------- | ----- | -------------------------- |
| `limitUrlsMax` | `Int` | Use limitLevelsMax instead |

### `ProjectConnectionFilterInput`

| Field            | Type                          | Deprecation Reason               |
| ---------------- | ----------------------------- | -------------------------------- |
| `limitUrlsMax`   | `ConnectionIntFilterInput`    | Renamed to limitPagesMax.        |
| `maxContentSize` | `ConnectionIntFilterInput`    | Renamed to maxBodyContentLength. |
| `sitePrimary`    | `ConnectionStringFilterInput` | Renamed to primaryDomain.        |
| `siteTest`       | `ConnectionStringFilterInput` | Renamed to testSiteDomain.       |

### `RequestCustomMetricContainerGenerationInput`

| Field      | Type      | Deprecation Reason                                  |
| ---------- | --------- | --------------------------------------------------- |
| `skipHtml` | `Boolean` | Moved to CustomMetricContainerGeneration.htmlNeeded |

### `TestSuiteConnectionFilterInput`

| Field            | Type                          | Deprecation Reason               |
| ---------------- | ----------------------------- | -------------------------------- |
| `limitUrlsMax`   | `ConnectionIntFilterInput`    | Renamed to limitPagesMax.        |
| `maxContentSize` | `ConnectionIntFilterInput`    | Renamed to maxBodyContentLength. |
| `sitePrimary`    | `ConnectionStringFilterInput` | Renamed to primaryDomain.        |
| `siteTest`       | `ConnectionStringFilterInput` | Renamed to testSiteDomain.       |

### `UpdateProjectInput`

| Field          | Type  | Deprecation Reason        |
| -------------- | ----- | ------------------------- |
| `limitUrlsMax` | `Int` | Use limitPagesMax instead |

### `UpdateUrlFileUploadInput`

| Field        | Type      | Deprecation Reason |
| ------------ | --------- | ------------------ |
| `customType` | `Boolean` | No longer used.    |

## Arguments

### `Query.datasource`

| Field  | Type     | Deprecation Reason          |
| ------ | -------- | --------------------------- |
| `code` | `String` | Use datasourceCode instead. |

## Enum Values

### `CrawlOrderField`

| Field                | Type   | Deprecation Reason                                                             |
| -------------------- | ------ | ------------------------------------------------------------------------------ |
| `brokenAt`           | `enum` | Legacy timestamp. No longer in use.                                            |
| `erroredAt`          | `enum` | Legacy timestamp. No longer in use.                                            |
| `errorMessage`       | `enum` | Legacy field. No longer in use.                                                |
| `isContainer`        | `enum` | No longer in use.                                                              |
| `processingAt`       | `enum` | Legacy timestamp. No longer in use. Use Crawl.crawledAt instead.               |
| `startedByApi`       | `enum` | Legacy setting. No longer in use.                                              |
| `useRobotsOverwrite` | `enum` | Legacy setting. No longer in use. Use CrawlSetting.useRobotsOverwrite instead. |

### `CrawlStatus`

| Field         | Type   | Deprecation Reason               |
| ------------- | ------ | -------------------------------- |
| `Archiving`   | `enum` | Legacy status. No longer in use. |
| `Discovering` | `enum` | Legacy status. No longer in use. |
| `Draft`       | `enum` | Legacy status. No longer in use. |
| `Errored`     | `enum` | Legacy status. No longer in use. |
| `Queuing`     | `enum` | Legacy status. No longer in use. |

### `DatasourceCode`

| Field                     | Type   | Deprecation Reason |
| ------------------------- | ------ | ------------------ |
| `CrawlSitemapDiscoveries` | `enum` | No longer in use.  |

### `PermissionCode`

| Field        | Type   | Deprecation Reason |
| ------------ | ------ | ------------------ |
| `AdminGrant` | `enum` | No longer in use.  |
| `Beta`       | `enum` | No longer in use.  |
| `Dev`        | `enum` | No longer in use.  |

### `ProjectOrderField`

| Field            | Type   | Deprecation Reason               |
| ---------------- | ------ | -------------------------------- |
| `limitUrlsMax`   | `enum` | Renamed to limitPagesMax.        |
| `maxContentSize` | `enum` | Renamed to maxBodyContentLength. |
| `sitePrimary`    | `enum` | Renamed to primaryDomain.        |
| `siteTest`       | `enum` | Renamed to testSiteDomain.       |

### `TestSuiteOrderField`

| Field            | Type   | Deprecation Reason               |
| ---------------- | ------ | -------------------------------- |
| `limitUrlsMax`   | `enum` | Renamed to limitPagesMax.        |
| `maxContentSize` | `enum` | Renamed to maxBodyContentLength. |
| `sitePrimary`    | `enum` | Renamed to primaryDomain.        |
| `siteTest`       | `enum` | Renamed to testSiteDomain.       |