Segments endpoint

Segments documentation

Fetch all segments

segments(project_id, key_id, lang_iso[, params = None])

Parameters:

• project_id (str) – ID of the project

• key_id (int or str) – ID of the key

• lang_iso (str) – Language ISO code

• params (dict) – (optional) Additional params

Returns:

Collection of segments

Example:

client.segments("123.abc", 4567, "en-US", {"disable_references": '1'})

Fetch a segment

segment(project_id, key_id, lang_iso, segment_number[, params = None])

Parameters:

• project_id (str) – ID of the project

• key_id (int or str) – ID of the key

• lang_iso (str) – Language ISO code

• segment_number (int or str) – Number of the segment

• params (dict) – (optional) Additional params

Returns:

Segment model

Example:

client.segment("123.abc", 4567, "en-US", 2, {"disable_references": '1'})

Update a segment

update_segment(project_id, key_id, lang_iso, segment_number, params)

Parameters:

• project_id (str) – ID of the project

• key_id (int or str) – ID of the key

• lang_iso (str) – Language ISO code

• segment_number (int or str) – Number of the segment

• params (dict) – Segment params

Returns:

Segment model

Example:

client.update_segment("123.abc", 4567, "en-US", 2, {
    "value": "Hello from Python!",
    "is_reviewed": True
})