Skip to main content

How to Get Crawls

The following guide will provide you with the essentials needed to query the Lumar API for your previously completed crawls.

Note: in order to execute getProject queries, make sure you're authenticated.

Using the getProject query​

Make sure you have the Project ID. This can be obtained by clicking on a project and copying it from the URL.

For example: https://analyze.lumar.io/accounts/1479/projects/[COPY_PROJECT_ID]/crawls/1583246)

Operation: query GetProject($id: ObjectID!) { getProject(id: $id) { name sitePrimary crawls(first: 10) { nodes { finishedAt id project { name } status } } } }Variables: { "id": 62023 }Response Example: { "data": { "getProject": { "name": "Deep Crawl", "sitePrimary": "https://www.lumar.io/", "crawls": { "nodes": [ { "finishedAt": "2020-07-09T16:25:35.000Z", "id": "TjAwNUNyYXdsMTU4MzI0NQ", "project": { "name": "Deep Crawl" }, "status": "finished" }, { "finishedAt": "2020-07-09T17:03:44.000Z", "id": "TjAwNUNyYXdsMTU4MzI0Ng", "project": { "name": "Deep Crawl" }, "status": "finished" } ] } } } }
GetProjectTry in Explorer
GraphQL
query GetProject($id: ObjectID!) {
  getProject(id: $id) {
    name
    sitePrimary
    crawls(first: 10) {
      nodes {
        finishedAt
        id
        project {
          name
        }
        status
      }
    }
  }
}

The following guide will provide you with the essentials needed to query the Lumar API for your previously completed crawls.

Note: in order to execute getCrawl queries, make sure you're authenticated.

Using the getCrawl query​

If you already know the crawl ID, you can use the getCrawl query to get the crawl details.

Operation: query { getCrawl(id: 1583246) { finishedAt id project { name } status } }Response Example: { "data": { "getCrawl": { "finishedAt": "2020-07-09T17:03:44.000Z", "id": "TjAwNUNyYXdsMTU4MzI0Ng", "project": { "name": "Deep Crawl" }, "status": "finished" } } }
queryTry in Explorer
GraphQL
query {
  getCrawl(id: 1583246) {
    finishedAt
    id
    project {
      name
    }
    status
  }
}