Responses

Success

API Response Success Schema and Details. Status codes, pagination, and SDK integration examples

Status Codes and Description

Here are all the responses success status codes and their description

Status Code	Description	Possible Response Schema	Body
`200`OK	When retrieving a resource	ResponseOk / ResponseWithPagination	Resource / Resources and pagination
`201` Created	When creating a new resource	ResponseOk	Resource created
`204` No Content	Updating or deleting a resource	ResponseNoContent	None

Response Ok Schema

data

any

Data contains the response object

success

string

Status indicates the response status "success" Examples: "success"

{
    "data": "<any>",
    "status": "success"
}

Response With Pagination Schema

The following resources will return a paginated response when requesting a list : job, source, file, notification, upload.

When requesting a list of these resources, the default and max limit is 100. So by default if there is more than 100 items that responds to your request you will need to use pagination to get through all of them.

data

any

Data contains the paginated items

limit

integer

Limit indicates the maximum number of items in the current response

offset

integer

Offset indicates the offset of the first item in the current response

total

integer

Total indicates the total number of items

success

string

Status indicates the response status "success" Examples: "success"

{
    "data": "<any>",
    "limit": 20,
    "offset": 0,
    "status": "success",
    "total": 154
}

Pagination use with our SDK

Some quick examples on how to use pagination with our SDK:

import { createClient } from 'chunkify';

const client = createClient({
    projectToken: 'your_token',
});

// List all the sources with limit 10
const paginatedResults = await client.source.list({
    limit: 10,
});

// You can access the first page of result
console.log(paginatedResults.items);

// Or Iterate over the paginated results
for await (const page of paginatedResults) {
    // Access the current page of sources
    page.items.forEach((source) => {
        console.log(source.id, source.url);
    });
}

from chunkify import Client

client = Client.create(project_token="your_token")

# List all the sources with limit 10
paginated_results = client.source.list(
    limit=10,
)

# You can access the first page of result
print(paginated_results.items)

# Or Iterate through pages
for page in paginated_results:
    # Access the current page of sources
    for source in page.items:
        print(source.id, source.url)
use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

// List all the sources with limit 10
$paginatedResults = $client->sources->list(limit: 10);

// You can access the first page of result
print_r($paginatedResults->getItems());

// Or automatically fetch and iterate through every page
foreach ($paginatedResults->pagingEachItem() as $source) {
    printf("Source ID: %s, URL: %s\n", $source->id, $source->url);
}

import "github.com/chunkifydev/chunkify-go"

client := chunkify.NewClient(chunkify.AccessTokens{
    ProjectToken: "yourToken",
})

// List all the sources with limit 10
paginatedResult, err := client.SourceList(chunkify.SourceListParams{
    Limit: 10,
})
if err != nil {
    t.Fatalf("Error listing sources: %v", err)
}

// You can access the first page of result
fmt.Println(paginatedResult.Items)

// Or iterate over the paginated results
for paginatedResult != nil {
    // Access current page
    for _, source := range paginatedResult.Items {
        fmt.Printf("Source ID: %s, URL: %s\n", source.Id, source.Url)
    }
    // Try to get next page
    if nextPage, err := paginatedResult.Next(); err != nil {
        paginatedResult = nil
    } else {
        paginatedResult = nextPage
    }
}