Clean Ocean

As the name suggests, this endpoint allows you to clean ocean. On this page, we'll dive into how you can clean ocean programmatically. You can remove ocean waste by yourself or on behalf of your customers. If you wish to clean waste on behalf of your customers, you need to provide the customer_email. We use the provided email to give your customers the ability to track the impact they made.

POST/v1/clean_ocean

Clean ocean

This endpoint enables you to clean ocean. To remove waste on behalf of your customers, you must provide the customer_email. customer_name is optional. However, if you plan to make an impact on behalf of your customers or give them the ability to track their impact, you need to provide the customer_email.

Required request body attributes

Name
amount
Type
integer
Description
The amount of waste (in lbs) you wish to remove in a single request. The value must be between 1 and 10,000,000.

Optional request body attributes

Name
customer_email
Type
string
Description
The email of the customer if you are sending a request to clean ocean on their behalf. Must be a valid email address.
Name
customer_name
Type
string
Description
The name of the customer if you are sending a request to clean ocean on their behalf. customer_email must be present.

Request

POST

/v1/clean_ocean

curl --location https://api.1clickimpact.com/v1/clean_ocean \
--header 'Content-Type: application/json' \
--header 'x-api-key: {PRODUCTION API KEY}' \
---data-raw '{
    "amount": 5
    }'

Response

{
  "user_id": "U123",
  "waste_removed": 5,
  "time_utc": "2024-09-16T20:34:04.429Z"
}

Request (for Customer)

POST

/v1/clean_ocean

curl --location https://api.1clickimpact.com/v1/clean_ocean \
--header 'Content-Type: application/json' \
--header 'x-api-key: {PRODUCTION API KEY}' \
---data-raw '{
    "amount": 5,
    "customer_email": "sample-customer@email.com",
    "customer_name": "Sample Customer"
    }'

Response (for Customer)

{
  "user_id": "U123",
  "waste_removed": 5,
  "customer": {
    "customer_id": "U12345",
    "customer_email": "sample-customer@email.com",
    "customer_name": "Sample Customer"
  },
  "time_utc": "2024-09-16T20:34:04.429Z"
}

GET/v1/records

Retrieve your ocean waste removed records

This endpoint allows you to query your ocean waste removed records. Refer to customer records at the bottom to see how to query customer ocean waste removed records.

Optional query params

Name
filter_by
Type
string
Description
The impact type of the records you want to query. To retrieve the ocean waste removed records filter_by should be "waste_removed".
Name
start_date
Type
string
Description
The start date after which you want to query the records. The start_date should be in the format yyyy-mm-dd.
Name
end_date
Type
string
Description
The end date up to which you want to query the records. The end_date should be in the format yyyy-mm-dd.
Name
limit
Type
integer
Description
Limit the number of records returned. The default value is 10. The value must be between 0 and 1000.
Name
cursor
Type
string
Description
The cursor from the response can be used as query parameter in the next request to fetch the subsequent list of records. Refer to Pagination section for more details.

Request

GET

/v1/records

curl --location 'https://api.1clickimpact.com/v1/records?filter_by=waste_removed' \
--header 'x-api-key: {PRODUCTION API KEY}'

Response

{
  "user_records":
  [
    {
        "user_id": "U123",
        "time_utc": "2024-09-16T20:30:13.391Z",
        "waste_removed": 5
    },
    {
        "user_id": "U123",
        "time_utc": "2024-09-17T13:24:04.429Z",
        "waste_removed": 15
    },
    {
        "user_id": "U123",
        "time_utc": "2024-09-17T14:32:01.638Z",
        "waste_removed": 10
    },
    {...},
    {...}
  ],
  "cursor": "fNJjcmV32dGVkTiOiIyMDI0LTA3LTidXNlcklE3UiVTk2OTQ0MDcwIpT"
}

GET/v1/customer-records

Retrieve customer ocean waste removed records

This endpoint allows you to query customer ocean waste removed records for all or a specific customer.

Optional query params

Name
customer_email
Type
string
Description
The email of the customer whose records you want to retrieve.
Name
filter_by
Type
string
Description
The impact type of the records you want to query. To retrieve the ocean waste removed records filter_by should be "waste_removed".
Name
start_date
Type
string
Description
The start date after which you want to query the records. The start_date should be in the format yyyy-mm-dd.
Name
end_date
Type
string
Description
The end date up to which you want to query the records. The end_date should be in the format yyyy-mm-dd.
Name
limit
Type
integer
Description
Limit the number of records returned. The default value is 10. The value must be between 0 and 1000.
Name
cursor
Type
string
Description
The cursor from the response can be used as query parameter in the next request to fetch the subsequent list of records. Refer to Pagination section for more details.

Request

GET

/v1/records

curl --location 'https://api.1clickimpact.com/v1/customer_records?filter_by=waste_removed' \
--header 'x-api-key: {PRODUCTION API KEY}'

Response

{
  "customer_records":
  [
     {
        "user_id": "U123",
        "customer": {
            "customer_id": "U1234",
            "customer_email": "sample-customer-1@email.com",
            "customer_name": "Sample Customer 1"
        },
        "time_utc": "2024-06-12T15:22:14.753Z",
        "waste_removed": 40
    },
    {
        "user_id": "U123",
        "customer": {
            "customer_id": "U789",
            "customer_email": "sample-customer-2@email.com",
            "customer_name": "Sample Customer 2"
        },
        "time_utc": "2024-06-15T16:41:58.323Z",
        "waste_removed": 50
    },
    {
        "user_id": "U123",
        "customer": {
            "customer_id": "U5678",
             "customer_email": "sample-customer-3@email.com",
            "customer_name": "Sample Customer 3"
        },
        "time_utc": "2024-06-21T18:16:02.083Z",
        "waste_removed": 10
    },
    {
        "user_id": "U123",
        "customer": {
            "customer_id": "U3456",
            "customer_email": "sample-customer-4@email.com",
            "customer_name": "Sample Customer 4"
        },
        "time_utc": "2024-06-21T20:34:35.913Z",
        "waste_removed": 150
    },
    {...},
    {...}
  ],
  "cursor": "eyJjcmVhdGVkT24iOiIyMDI0LTA3LTidXNlcklEIjoiVTk2OTQ0MDcwIn0="
}