Get all leads. Use the unlocked routes for more lead details

GET/v2/customers/{customerId}/leads

API-Version

Request-Methode

GET

Operation-ID

leadfyndr-list-leads

Request

customerIdstringrequired

Responses

Response-Header

X-Pagination-Limitinteger
The limit used to select the resources for the response
X-Pagination-Skipinteger
The number of skipped items
X-Pagination-Pagenumber
The calculate page of the list response. Refer to parameters to learn more.
X-Pagination-TotalCountinteger
The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Beschreibung

The leads list. Remember: more details will be given in the unlocked routes.

leadsArray von objectrequired
- Array[
  - *object
    - businessFieldsArray von stringrequired
      - Array[
        *string
        ]
    - companyobjectrequired
      - countystringrequired
      - employeeCountinteger (int64)
      - foundingYearnumber
      - salesVolumeinteger (int64)
    - descriptionstringrequired
    - hosterobjectrequired
      - serverArray von stringrequired
        Array[
        *string
        ]
    - languagesArray von stringrequired
      - Array[
        *string
        ]
    - leadIdstringrequired
    - mainTechnologyobject
      - categoriesArray von object
        Array[
        *object
        namestringrequired
        parentCategoriesArray von string
        Array[
        *string
        ]
        prioritynumberrequired
        ]
      - categoryPriorityintegerrequired
      - namestringrequired
      - versionstring
    - metricsobjectrequired
      - co2number (≥ 0, float)
      - contentLoadednumber (≥ 0, float)
      - desktopobjectrequired
        accessibilitynumber (≥ 0, float)
        bestPracticenumber (≥ 0, float)
        cumulativeLayoutShiftnumber (≥ 0, float)
        firstContentfulPaintnumber (≥ 0, float)
        largestContentfulPaintnumber (≥ 0, float)
        performancenumber (≥ 0, float)
        seonumber (≥ 0, float)
        totalBlockingTimenumber (≥ 0, float)
      - mobileobjectrequired
        accessibilitynumber (≥ 0, float)
        bestPracticenumber (≥ 0, float)
        cumulativeLayoutShiftnumber (≥ 0, float)
        firstContentfulPaintnumber (≥ 0, float)
        largestContentfulPaintnumber (≥ 0, float)
        performancenumber (≥ 0, float)
        seonumber (≥ 0, float)
        totalBlockingTimenumber (≥ 0, float)
      - timeToFirstByteMsnumber
    - potentialnumber (≥ 0, float)required
    - scannedAtstring (date-time)
    - screenshotstringrequired
    - technologiesArray von objectrequired
      - Array[
        *object
        categoriesArray von object
        Array[
        *object
        namestringrequired
        parentCategoriesArray von string
        Array[
        *string
        ]
        prioritynumberrequired
        ]
        categoryPriorityintegerrequired
        namestringrequired
        versionstring
        ]
  ]
limitnumberrequired
skipnumberrequired
totalCountnumberrequired

Content-Type: application/json

{
  "leads": [
    {
      "businessFields": [
        "string"
      ],
      "company": {
        "county": "string",
        "employeeCount": 123,
        "foundingYear": 123,
        "salesVolume": 123
      },
      "description": "string",
      "hoster": {
        "server": [
          "string"
        ]
      },
      "languages": [
        "string"
      ],
      "leadId": "string",
      "mainTechnology": {
        "categories": [
          {
            "name": "string",
            "parentCategories": [
              "string"
            ],
            "priority": 123
          }
        ],
        "categoryPriority": 123,
        "name": "string",
        "version": "string"
      },
      "metrics": {
        "co2": 123,
        "contentLoaded": 123,
        "desktop": {
          "accessibility": 123,
          "bestPractice": 123,
          "cumulativeLayoutShift": 123,
          "firstContentfulPaint": 123,
          "largestContentfulPaint": 123,
          "performance": 123,
          "seo": 123,
          "totalBlockingTime": 123
        },
        "mobile": {
          "accessibility": 123,
          "bestPractice": 123,
          "cumulativeLayoutShift": 123,
          "firstContentfulPaint": 123,
          "largestContentfulPaint": 123,
          "performance": 123,
          "seo": 123,
          "totalBlockingTime": 123
        },
        "timeToFirstByteMs": 123
      },
      "potential": 123,
      "scannedAt": "1985-10-26T01:21:00.000Z",
      "screenshot": "string",
      "technologies": [
        {
          "categories": [
            {
              "name": "string",
              "parentCategories": [
                "string"
              ],
              "priority": 123
            }
          ],
          "categoryPriority": 123,
          "name": "string",
          "version": "string"
        }
      ]
    }
  ],
  "limit": 123,
  "skip": 123,
  "totalCount": 123
}

{
  "properties": {
    "leads": {
      "items": {
        "properties": {
          "businessFields": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "company": {
            "properties": {
              "county": {
                "type": "string"
              },
              "employeeCount": {
                "format": "int64",
                "type": "integer"
              },
              "foundingYear": {
                "type": "number"
              },
              "salesVolume": {
                "format": "int64",
                "type": "integer"
              }
            },
            "required": [
              "county"
            ],
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "hoster": {
            "properties": {
              "server": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            },
            "required": [
              "server"
            ],
            "type": "object"
          },
          "languages": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "leadId": {
            "type": "string"
          },
          "mainTechnology": {
            "properties": {
              "categories": {
                "items": {
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "parentCategories": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "priority": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "name",
                    "priority"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "categoryPriority": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "version": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "categoryPriority"
            ],
            "type": "object"
          },
          "metrics": {
            "properties": {
              "co2": {
                "format": "float",
                "minimum": 0,
                "type": "number"
              },
              "contentLoaded": {
                "format": "float",
                "minimum": 0,
                "type": "number"
              },
              "desktop": {
                "properties": {
                  "accessibility": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "bestPractice": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "cumulativeLayoutShift": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "firstContentfulPaint": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "largestContentfulPaint": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "performance": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "seo": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "totalBlockingTime": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  }
                },
                "type": "object"
              },
              "mobile": {
                "properties": {
                  "accessibility": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "bestPractice": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "cumulativeLayoutShift": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "firstContentfulPaint": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "largestContentfulPaint": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  },
                  "performance": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "seo": {
                    "format": "float",
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "totalBlockingTime": {
                    "format": "float",
                    "minimum": 0,
                    "type": "number"
                  }
                },
                "type": "object"
              },
              "timeToFirstByteMs": {
                "type": "number"
              }
            },
            "required": [
              "desktop",
              "mobile"
            ],
            "type": "object"
          },
          "potential": {
            "format": "float",
            "maximum": 1,
            "minimum": 0,
            "type": "number"
          },
          "scannedAt": {
            "format": "date-time",
            "type": "string"
          },
          "screenshot": {
            "type": "string"
          },
          "technologies": {
            "items": {
              "properties": {
                "categories": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "parentCategories": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "priority": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "name",
                      "priority"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "categoryPriority": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "version": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "categoryPriority"
              ],
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "leadId",
          "potential",
          "screenshot",
          "company",
          "metrics",
          "businessFields",
          "description",
          "technologies",
          "hoster",
          "languages"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "limit": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    },
    "totalCount": {
      "type": "number"
    }
  },
  "required": [
    "leads",
    "totalCount",
    "skip",
    "limit"
  ],
  "type": "object"
}

Format

application/json

Beschreibung

Validation Error caused by invalid input data in the request

type"ValidationError"required
messagestring
validationErrorsArray von objectrequired
- Array[
  - *object
    - messagestringrequired
      The standard error message
    - pathstringrequired
      The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.
    - typestringrequired
      ajv validation error type (e.g. "format", "required", "type") or own validation error types
    - contextobject
      The object with the additional information about the error that can be used to create custom error messages. Keys depend on the type that failed validation (e.g. "missingProperty" for type "required")
      - *string
  ]

Content-Type: application/json

{
  "type": "ValidationError",
  "message": "Validation failed",
  "validationErrors": [
    {
      "message": "should be string",
      "path": ".address.street",
      "type": "format",
      "context": {
        "format": "email"
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "type",
    "validationErrors"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "ValidationError"
      ]
    },
    "message": {
      "type": "string",
      "example": "Validation failed"
    },
    "validationErrors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message",
          "path",
          "type"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "The standard error message",
            "example": "should be string"
          },
          "path": {
            "type": "string",
            "description": "The path to the part of the data that was validated. JavaScript property access notation (e.g., \".prop[1].subProp\") is used.\n",
            "example": ".address.street"
          },
          "type": {
            "type": "string",
            "description": "ajv validation error type (e.g. \"format\", \"required\", \"type\") or own validation error types",
            "example": "format"
          },
          "context": {
            "type": "object",
            "example": {
              "format": "email"
            },
            "description": "The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. \"missingProperty\" for type \"required\")\n",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Format

application/json

Beschreibung

Your request ran into a rate limit. You have to wait until rate limit expires

messagestring
typestring

Content-Type: application/json

{
  "message": "too many requests",
  "type": "RateLimitError"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "too many requests"
    },
    "type": {
      "type": "string",
      "example": "RateLimitError"
    }
  }
}

Format

application/json

Beschreibung

An unexpected Error that occurred while handling the request

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/leads?potentialRangeMin=123&potentialRangeMax=123&employeeCountMin=123&employeeCountMax=123&salesVolumeMin=123&salesVolumeMax=123&technologies=string&businessFields=string&locationCity=string&locationPostCode=string&locationRadiusInKm=123&basic%3AtimeToFirstByteMs%3Amin=123&basic%3AtimeToFirstByteMs%3Amax=123&basic%3Adesktop%3Aperformance%3Amin=123&basic%3Adesktop%3Aperformance%3Amax=123&basic%3Amobile%3Aperformance%3Amin=123&basic%3Amobile%3Aperformance%3Amax=123&limit=50&page=1&sort=potential&order=asc

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.leadFyndr.listLeads({
  "customerId": "string",
  "queryParameters": {
    "potentialRangeMin": 123,
    "potentialRangeMax": 123,
    "employeeCountMin": 123,
    "employeeCountMax": 123,
    "salesVolumeMin": 123,
    "salesVolumeMax": 123,
    "technologies": [
      "string"
    ],
    "businessFields": [
      "string"
    ],
    "locationCity": "string",
    "locationPostCode": "string",
    "locationRadiusInKm": 123,
    "basic:timeToFirstByteMs:min": 123,
    "basic:timeToFirstByteMs:max": 123,
    "basic:desktop:performance:min": 123,
    "basic:desktop:performance:max": 123,
    "basic:mobile:performance:min": 123,
    "basic:mobile:performance:max": 123,
    "limit": 50,
    "page": 1,
    "sort": "potential",
    "order": "asc"
  }
});

assertStatus(response, 200);
  

use \Mittwald\ApiClient\Generated\V2\Clients\LeadFyndr\ListLeads\ListLeadsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListLeadsRequest(
  customerId: "string"
))
  ->withPotentialRangeMin(123)
  ->withPotentialRangeMax(123)
  ->withEmployeeCountMin(123)
  ->withEmployeeCountMax(123)
  ->withSalesVolumeMin(123)
  ->withSalesVolumeMax(123)
  ->withTechnologies(["string"])
  ->withBusinessFields(["string"])
  ->withLocationCity("string")
  ->withLocationPostCode("string")
  ->withLocationRadiusInKm(123)
  ->withBasicTimeToFirstByteMsMin(123)
  ->withBasicTimeToFirstByteMsMax(123)
  ->withBasicDesktopPerformanceMin(123)
  ->withBasicDesktopPerformanceMax(123)
  ->withBasicMobilePerformanceMin(123)
  ->withBasicMobilePerformanceMax(123)
  ->withLimit(50)
  ->withPage(1)
  ->withSort("potential")
  ->withOrder("asc");
$response = $client->leadFyndr()->listLeads($request);

var_dump($response->getBody();
  

Get all leads. Use the unlocked routes for more lead details

Request​

Pfad-Parameterrequired

Query-Parameter

Responses​

OK200

Bad Request400

Too Many Requests429

default

Nutzungsbeispiele​

Auf dieser Seite

Request

Responses

Nutzungsbeispiele