Working with the Lookups API
- Juan Tomás Alonso Nieto (Deactivated)
- Julio Vargas
- Jonas Gonzalez
Overview
Check the list of available endpoints and methods in the Lookups API:
Endpoints and methods | Description | |
|---|---|---|
| 1 | GET | Display information on the lookups existing on a given domain. |
| 2 | GET | Return information of a specific lookup. |
| 3 | GET | Query the job UUIDs of a specific lookup. |
| 4 | GET | Query the statuses of a lookup job. |
| 5 | Advanced mode POST | Advanced mode Create a new lookup. |
| 6 | POST | Create a new lookup using a CSV (application/json request body) |
| 7 | POST | Create a new lookup using a CSV (multipart/form-data request body) |
| 8 | POST | Create a new lookup based on a static query. |
| 9 | POST | Create a new lookup based on a periodic query. |
| 10 | POST | Create a new lookup based on a sliding window query. |
| 11 | Advanced mode PUT | Advanced mode Update a specific lookup. |
| 12 | PUT | Update a CSV lookup (application/json request body) |
| 13 | PUT | Update a CSV lookup (multipart/form-data request body) |
| 14 | PUT | Update a lookup based on a static query. |
| 15 | PUT | Update a lookup based on a periodic query. |
| 16 | PUT | Update a lookup based on a sliding window query. |
| 17 | DELETe | Send a request to delete a specific lookup. |
Endpoints and methods
GET /lookup/{domain}
Display information on the lookups existing on a given domain.
GET /lookup/{domain}/{name}
Return information of a specific lookup.
GET /lookup/{domain}/{name}/job
Query the job UUIDs (Universally Unique IDentifier) of a specific lookup. A new job is created for each create, update or delete process that is initiated. Each job is identified by a unique ID, or UUID.
You will get the last 10 UUIDs for the requested lookup. The list is ordered chronologically being the first job UUID the oldest and the last one the newest.
GET /lookup/{domain}/{name}/job/{id}
Query the statuses of a lookup job given its UUID. You can get a job UUID using the request explained above.
You will get the last 50 statuses for the requested lookup job. The list is ordered chronologically being the first status the oldest and the last one the newest.
These are the possible status codes you may get in your response:
Code | Status |
|---|---|
| Lookup creation started. |
| Lookup successfully created. |
| Error creating lookup. |
| Lookup synchronous upload started. |
| Successful lookup synchronous upload. |
| Lookup synchronous upload failed. |
| Lookup asynchronous upload started. |
| Successful lookup asynchronous upload started. |
| Lookup asynchronous upload failed. |
| Lookup deletion started. |
| Lookup successfully deleted. |
| Error deleting lookup. |
POST /lookup/{domain}/{name}/deploy-config
Create a new lookup.
POST /lookup/{domain}/{name}/deploy-csv
Simplified endpoint to create a new lookup from a CSV file (application/json request body).
POST /lookup/{domain}/{name}/deploy-csv
Simplified endpoint to create a new lookup from a CSV file (multipart/form-data request body).
POST /lookup/{domain}/{name}/deploy-static-query
Simplified endpoint to create a new lookup based on a static query.
POST /lookup/{domain}/{name}/deploy-periodic-query
Simplified endpoint to create a new lookup based on a periodic query.
POST /lookup/{domain}/{name}/deploy-sliding-window-query
Simplified endpoint to create a new lookup based on a sliding window query.
PUT lookup/{domain}/{name}/deploy-config
Update a specific lookup.
PUT lookup/{domain}/{name}/deploy-csv
Update a CSV lookup (application/json request body).
PUT lookup/{domain}/{name}/deploy-csv
Update a CSV lookup (multipart/form-data request body).
PUT lookup/{domain}/{name}/deploy-static-query
Update a lookup based on a static query.
PUT lookup/{domain}/{name}/deploy-periodic-query
Update a lookup based on a periodic query.
PUT lookup/{domain}/{name}/deploy-sliding-window-query
Update a lookup based on a sliding window query.
DELETE /lookup/{domain}/{name}
Send a request to delete a specific lookup.