GOATS

The GOATS domain provides access to GOATS-specific data exposed through GraphQL.

Use goats to retrieve programs and observations used within GOATS workflows.

Quick Example

async with GPPClient() as client:
   programs = await client.goats.get_programs()

Programs

Get all GOATS programs:

result = await client.goats.get_programs()

Observations

Get GOATS observations for a program:

result = await client.goats.get_observations_by_program_id("p-123")

Notes

All GOATS operations use GraphQL and return generated response models.

Refer to the generated types for the full response structure.

API Reference

class gpp_client.domains.goats.GOATSDomain(*, graphql: GraphQLClient, rest: RESTClient, settings: GPPSettings)[source]

Bases: BaseDomain

Domain class for GOATS-related operations.

async get_observations_by_program_id(*, program_id: str) → GetGOATSObservations[source]

Get GOATS observations for a program.

Parameters:

program_id (str) – The program ID.

Returns:

The generated GraphQL response model.

Return type:

GetGOATSObservations

async get_programs() → GetGOATSPrograms[source]

Get GOATS programs.

Returns:

The generated GraphQL response model.

Return type:

GetGOATSPrograms